Integrating with code

Using Python

Install the mysoc-dataset package. You can then use the following code to get this file.

        from mysoc_dataset import get_dataset_url, get_dataset_df

        # get the url of dataset
        url = get_dataset_url(
            repo_name="la-plans-promises",
            package_name="local_authority_net_zero_commitments",
            version_name="0.1",
            file_name="promises.parquet",
        )
        
        
        # get a pandas dataframe
        df = get_dataset_df(
            repo_name="la-plans-promises",
            package_name="local_authority_net_zero_commitments",
            version_name="0.1",
            file_name="promises.parquet",
        )
        
      

You can also use this package as a command-line tool:

        mysoc-dataset download \
        --repo la-plans-promises \
        --package local_authority_net_zero_commitments \
        --version 0.1 \
        --file promises.parquet
      

Use mysoc-dataset --help for all options.