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_climate_plans_metadata",
            version_name="0.11.0",
            file_name="plans.parquet",
        )
        
        
        # get a pandas dataframe
        df = get_dataset_df(
            repo_name="la-plans-promises",
            package_name="local_authority_climate_plans_metadata",
            version_name="0.11.0",
            file_name="plans.parquet",
        )
        
      

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

        mysoc-dataset download \
        --repo la-plans-promises \
        --package local_authority_climate_plans_metadata \
        --version 0.11.0 \
        --file plans.parquet
      

Use mysoc-dataset --help for all options.