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="composite_uk_imd",
            package_name="uk_index",
            version_name="latest",
            file_name="UK_IMD_W.parquet",
        )
        
        
        # get a pandas dataframe
        df = get_dataset_df(
            repo_name="composite_uk_imd",
            package_name="uk_index",
            version_name="latest",
            file_name="UK_IMD_W.parquet",
        )
        
      

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

        mysoc-dataset download \
        --repo composite_uk_imd \
        --package uk_index \
        --version latest \
        --file UK_IMD_W.parquet
      

Use mysoc-dataset --help for all options.