diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-18 04:00:31 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-18 04:00:31 +0000 |
| commit | 4419154b2abcd3a5625abdbd7b23993b4da20905 (patch) | |
| tree | 7686328983b70149cf376e62a6534ad6997bd356 | |
| parent | 268ef53fb3b1e2bf007d3d63ba4f43b027fd21fa (diff) | |
automatic import of python-census-data-downloader
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-census-data-downloader.spec | 531 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 533 insertions, 0 deletions
@@ -0,0 +1 @@ +/census-data-downloader-0.0.36.tar.gz diff --git a/python-census-data-downloader.spec b/python-census-data-downloader.spec new file mode 100644 index 0000000..677b1f8 --- /dev/null +++ b/python-census-data-downloader.spec @@ -0,0 +1,531 @@ +%global _empty_manifest_terminate_build 0 +Name: python-census-data-downloader +Version: 0.0.36 +Release: 1 +Summary: Download U.S. census data and reformat it for humans +License: MIT +URL: http://www.github.com/datadesk/census-data-downloader +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/ae/e0/2a61403b8382c9bdbccab1507b9a9b834a6a538d92b38d1763ae290f71fe/census-data-downloader-0.0.36.tar.gz +BuildArch: noarch + +Requires: python3-pandas +Requires: python3-us +Requires: python3-census +Requires: python3-census-data-aggregator +Requires: python3-click +Requires: python3-jinja2 + +%description +# census-data-downloader + +Download [American Community Survey data](https://www.census.gov/programs-surveys/acs/data.html) from the U.S. Census Bureau and reformat it for humans. + +## What's available + +All of the data files processed by this repository are published in the [`data/processed/`](./data/processed/) folder. They can be called in to applications via their raw URLs, like https://raw.githubusercontent.com/datadesk/census-data-downloader/master/data/processed/acs5_2017_population_counties.csv + +## The command-line interface + +The library can be installed as a command-line interface that lets you download files on demand. + +### Installation + +```bash +$ pipenv install census-data-downloader +``` + +### Command-line usage + +There's now a tool named `censusdatadownloader` ready for you. + +```bash +Usage: censusdatadownloader [OPTIONS] TABLE COMMAND [ARGS]... + + Download Census data and reformat it for humans + +Options: + --data-dir TEXT The folder where you want to download the data + --year [2009-2020] The years of data to download. By default it gets only the + latest year. Not all data are available for every year. Submit 'all' to get every year. + --force Force the downloading of the data + --help Show this message and exit. + +Commands: + aiannhhomelands Download American Indian, Alaska Native and... + cnectas Download combined New England city and town... + congressionaldistricts Download Congressional districts + counties Download counties in all states + csas Download combined statistical areas + divisions Download divisions + elementaryschooldistricts Download elementary school districts + everything Download everything from everywhere + msas Download metropolitian statistical areas + nationwide Download nationwide data + nectas Download New England city and town areas + places Download Census-designated places + pumas Download public use microdata areas + regions Download regions + secondaryschooldistricts Download secondary school districts + statelegislativedistricts Download statehouse districts + states Download states + tracts Download Census tracts + unifiedschooldistricts Download unified school districts + urbanareas Download urban areas + zctas Download ZIP Code tabulation areas +``` + +Before you can use it you will need to add your CENSUS_API_KEY to your environment. If you don't have an API key, you can go [here.](https://api.census.gov/data/key_signup.html) One quick way to add your key: + +```bash +$ export CENSUS_API_KEY='<your API key>' +``` + +Using it is as simple as providing one our processed table names to one of the download subcommands. + +Here's an example of downloading all state-level data from the `medianage` dataset. + +```bash +$ censusdatadownloader medianage states +``` + +You can specify the download directory with `--data-dir`. + +```bash +$ censusdatadownloader --data-dir ./my-special-folder/ medianage states +``` + +And you can change the year you download with `--year`. + +```bash +$ censusdatadownloader --year 2010 medianage states +``` + +That's it. Mix and match tables and subcommands to get whatever you need. + +### Python usage + +You can also download tables from Python scripts. Import the class of the [processed table](https://github.com/datadesk/census-data-downloader/tree/master/census_data_downloader/tables) you wish to retrieve and pass in your API key. Then call one of the download methods. + +This example brings in all state-level data from the medianhouseholdincomeblack dataset. + +```python +>>> from census_data_downloader.tables import MedianHouseholdIncomeBlackDownloader +>>> downloader = MedianHouseholdIncomeBlackDownloader('<YOUR KEY>') +>>> downloader.download_states() +``` + +You can specify the data directory and the years by passing in the `data_dir` and `years` keyword arguments. + +```python +>>> downloader = MedianHouseholdIncomeBlackDownloader('<YOUR KEY>', data_dir='./', years=2016) +>>> downloader.download_states() +``` + +### Usage examples + +A gallery of graphics powered by our data is available on [Observable](https://observablehq.com/collection/@datadesk/u-s-census-data). + +[](https://observablehq.com/collection/@datadesk/u-s-census-data) + +The Los Angeles Times used this library for [an analysis of Census undercounts](https://www.latimes.com/projects/la-na-census-native-americans-navajo-nation/) on Native American reservations. The code that powers it is available as an [open-source computational notebook](https://github.com/datadesk/native-american-census-analysis). + +[](https://www.latimes.com/projects/la-na-census-native-americans-navajo-nation/) + +## Contributing to the library + +### Adding support for a new table + +Subclass our downloader and provided it with its required inputs. + +```python +import collections +from census_data_downloader.core.tables import BaseTableConfig +from census_data_downloader.core.decorators import register + + +@register +class MedianHouseholdIncomeDownloader(BaseTableConfig): + PROCESSED_TABLE_NAME = "medianhouseholdincome" # Your humanized table name + UNIVERSE = "households" # The universe value for this table + RAW_TABLE_NAME = 'B19013' # The id of the source table + RAW_FIELD_CROSSWALK = collections.OrderedDict({ + # A crosswalk between the raw field name and our humanized field name. + "001": "median" + }) +``` + +Add it to the imports in the [`__init__.py`](census_data_downloader/tables/__init__.py) file and it's good to go. + +### Developing the CLI + +The command-line interface is implemented using Click and setuptools. To install it locally for development inside your virtual environment, run the following installation command, as [prescribed by the Click documentation](https://click.palletsprojects.com/en/7.x/setuptools/#setuptools-integration). + +```bash +$ pip install --editable . +``` + +That's it. If you make some good ones, please consider submitting them as pull requests so everyone can benefit. + + + + +%package -n python3-census-data-downloader +Summary: Download U.S. census data and reformat it for humans +Provides: python-census-data-downloader +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-census-data-downloader +# census-data-downloader + +Download [American Community Survey data](https://www.census.gov/programs-surveys/acs/data.html) from the U.S. Census Bureau and reformat it for humans. + +## What's available + +All of the data files processed by this repository are published in the [`data/processed/`](./data/processed/) folder. They can be called in to applications via their raw URLs, like https://raw.githubusercontent.com/datadesk/census-data-downloader/master/data/processed/acs5_2017_population_counties.csv + +## The command-line interface + +The library can be installed as a command-line interface that lets you download files on demand. + +### Installation + +```bash +$ pipenv install census-data-downloader +``` + +### Command-line usage + +There's now a tool named `censusdatadownloader` ready for you. + +```bash +Usage: censusdatadownloader [OPTIONS] TABLE COMMAND [ARGS]... + + Download Census data and reformat it for humans + +Options: + --data-dir TEXT The folder where you want to download the data + --year [2009-2020] The years of data to download. By default it gets only the + latest year. Not all data are available for every year. Submit 'all' to get every year. + --force Force the downloading of the data + --help Show this message and exit. + +Commands: + aiannhhomelands Download American Indian, Alaska Native and... + cnectas Download combined New England city and town... + congressionaldistricts Download Congressional districts + counties Download counties in all states + csas Download combined statistical areas + divisions Download divisions + elementaryschooldistricts Download elementary school districts + everything Download everything from everywhere + msas Download metropolitian statistical areas + nationwide Download nationwide data + nectas Download New England city and town areas + places Download Census-designated places + pumas Download public use microdata areas + regions Download regions + secondaryschooldistricts Download secondary school districts + statelegislativedistricts Download statehouse districts + states Download states + tracts Download Census tracts + unifiedschooldistricts Download unified school districts + urbanareas Download urban areas + zctas Download ZIP Code tabulation areas +``` + +Before you can use it you will need to add your CENSUS_API_KEY to your environment. If you don't have an API key, you can go [here.](https://api.census.gov/data/key_signup.html) One quick way to add your key: + +```bash +$ export CENSUS_API_KEY='<your API key>' +``` + +Using it is as simple as providing one our processed table names to one of the download subcommands. + +Here's an example of downloading all state-level data from the `medianage` dataset. + +```bash +$ censusdatadownloader medianage states +``` + +You can specify the download directory with `--data-dir`. + +```bash +$ censusdatadownloader --data-dir ./my-special-folder/ medianage states +``` + +And you can change the year you download with `--year`. + +```bash +$ censusdatadownloader --year 2010 medianage states +``` + +That's it. Mix and match tables and subcommands to get whatever you need. + +### Python usage + +You can also download tables from Python scripts. Import the class of the [processed table](https://github.com/datadesk/census-data-downloader/tree/master/census_data_downloader/tables) you wish to retrieve and pass in your API key. Then call one of the download methods. + +This example brings in all state-level data from the medianhouseholdincomeblack dataset. + +```python +>>> from census_data_downloader.tables import MedianHouseholdIncomeBlackDownloader +>>> downloader = MedianHouseholdIncomeBlackDownloader('<YOUR KEY>') +>>> downloader.download_states() +``` + +You can specify the data directory and the years by passing in the `data_dir` and `years` keyword arguments. + +```python +>>> downloader = MedianHouseholdIncomeBlackDownloader('<YOUR KEY>', data_dir='./', years=2016) +>>> downloader.download_states() +``` + +### Usage examples + +A gallery of graphics powered by our data is available on [Observable](https://observablehq.com/collection/@datadesk/u-s-census-data). + +[](https://observablehq.com/collection/@datadesk/u-s-census-data) + +The Los Angeles Times used this library for [an analysis of Census undercounts](https://www.latimes.com/projects/la-na-census-native-americans-navajo-nation/) on Native American reservations. The code that powers it is available as an [open-source computational notebook](https://github.com/datadesk/native-american-census-analysis). + +[](https://www.latimes.com/projects/la-na-census-native-americans-navajo-nation/) + +## Contributing to the library + +### Adding support for a new table + +Subclass our downloader and provided it with its required inputs. + +```python +import collections +from census_data_downloader.core.tables import BaseTableConfig +from census_data_downloader.core.decorators import register + + +@register +class MedianHouseholdIncomeDownloader(BaseTableConfig): + PROCESSED_TABLE_NAME = "medianhouseholdincome" # Your humanized table name + UNIVERSE = "households" # The universe value for this table + RAW_TABLE_NAME = 'B19013' # The id of the source table + RAW_FIELD_CROSSWALK = collections.OrderedDict({ + # A crosswalk between the raw field name and our humanized field name. + "001": "median" + }) +``` + +Add it to the imports in the [`__init__.py`](census_data_downloader/tables/__init__.py) file and it's good to go. + +### Developing the CLI + +The command-line interface is implemented using Click and setuptools. To install it locally for development inside your virtual environment, run the following installation command, as [prescribed by the Click documentation](https://click.palletsprojects.com/en/7.x/setuptools/#setuptools-integration). + +```bash +$ pip install --editable . +``` + +That's it. If you make some good ones, please consider submitting them as pull requests so everyone can benefit. + + + + +%package help +Summary: Development documents and examples for census-data-downloader +Provides: python3-census-data-downloader-doc +%description help +# census-data-downloader + +Download [American Community Survey data](https://www.census.gov/programs-surveys/acs/data.html) from the U.S. Census Bureau and reformat it for humans. + +## What's available + +All of the data files processed by this repository are published in the [`data/processed/`](./data/processed/) folder. They can be called in to applications via their raw URLs, like https://raw.githubusercontent.com/datadesk/census-data-downloader/master/data/processed/acs5_2017_population_counties.csv + +## The command-line interface + +The library can be installed as a command-line interface that lets you download files on demand. + +### Installation + +```bash +$ pipenv install census-data-downloader +``` + +### Command-line usage + +There's now a tool named `censusdatadownloader` ready for you. + +```bash +Usage: censusdatadownloader [OPTIONS] TABLE COMMAND [ARGS]... + + Download Census data and reformat it for humans + +Options: + --data-dir TEXT The folder where you want to download the data + --year [2009-2020] The years of data to download. By default it gets only the + latest year. Not all data are available for every year. Submit 'all' to get every year. + --force Force the downloading of the data + --help Show this message and exit. + +Commands: + aiannhhomelands Download American Indian, Alaska Native and... + cnectas Download combined New England city and town... + congressionaldistricts Download Congressional districts + counties Download counties in all states + csas Download combined statistical areas + divisions Download divisions + elementaryschooldistricts Download elementary school districts + everything Download everything from everywhere + msas Download metropolitian statistical areas + nationwide Download nationwide data + nectas Download New England city and town areas + places Download Census-designated places + pumas Download public use microdata areas + regions Download regions + secondaryschooldistricts Download secondary school districts + statelegislativedistricts Download statehouse districts + states Download states + tracts Download Census tracts + unifiedschooldistricts Download unified school districts + urbanareas Download urban areas + zctas Download ZIP Code tabulation areas +``` + +Before you can use it you will need to add your CENSUS_API_KEY to your environment. If you don't have an API key, you can go [here.](https://api.census.gov/data/key_signup.html) One quick way to add your key: + +```bash +$ export CENSUS_API_KEY='<your API key>' +``` + +Using it is as simple as providing one our processed table names to one of the download subcommands. + +Here's an example of downloading all state-level data from the `medianage` dataset. + +```bash +$ censusdatadownloader medianage states +``` + +You can specify the download directory with `--data-dir`. + +```bash +$ censusdatadownloader --data-dir ./my-special-folder/ medianage states +``` + +And you can change the year you download with `--year`. + +```bash +$ censusdatadownloader --year 2010 medianage states +``` + +That's it. Mix and match tables and subcommands to get whatever you need. + +### Python usage + +You can also download tables from Python scripts. Import the class of the [processed table](https://github.com/datadesk/census-data-downloader/tree/master/census_data_downloader/tables) you wish to retrieve and pass in your API key. Then call one of the download methods. + +This example brings in all state-level data from the medianhouseholdincomeblack dataset. + +```python +>>> from census_data_downloader.tables import MedianHouseholdIncomeBlackDownloader +>>> downloader = MedianHouseholdIncomeBlackDownloader('<YOUR KEY>') +>>> downloader.download_states() +``` + +You can specify the data directory and the years by passing in the `data_dir` and `years` keyword arguments. + +```python +>>> downloader = MedianHouseholdIncomeBlackDownloader('<YOUR KEY>', data_dir='./', years=2016) +>>> downloader.download_states() +``` + +### Usage examples + +A gallery of graphics powered by our data is available on [Observable](https://observablehq.com/collection/@datadesk/u-s-census-data). + +[](https://observablehq.com/collection/@datadesk/u-s-census-data) + +The Los Angeles Times used this library for [an analysis of Census undercounts](https://www.latimes.com/projects/la-na-census-native-americans-navajo-nation/) on Native American reservations. The code that powers it is available as an [open-source computational notebook](https://github.com/datadesk/native-american-census-analysis). + +[](https://www.latimes.com/projects/la-na-census-native-americans-navajo-nation/) + +## Contributing to the library + +### Adding support for a new table + +Subclass our downloader and provided it with its required inputs. + +```python +import collections +from census_data_downloader.core.tables import BaseTableConfig +from census_data_downloader.core.decorators import register + + +@register +class MedianHouseholdIncomeDownloader(BaseTableConfig): + PROCESSED_TABLE_NAME = "medianhouseholdincome" # Your humanized table name + UNIVERSE = "households" # The universe value for this table + RAW_TABLE_NAME = 'B19013' # The id of the source table + RAW_FIELD_CROSSWALK = collections.OrderedDict({ + # A crosswalk between the raw field name and our humanized field name. + "001": "median" + }) +``` + +Add it to the imports in the [`__init__.py`](census_data_downloader/tables/__init__.py) file and it's good to go. + +### Developing the CLI + +The command-line interface is implemented using Click and setuptools. To install it locally for development inside your virtual environment, run the following installation command, as [prescribed by the Click documentation](https://click.palletsprojects.com/en/7.x/setuptools/#setuptools-integration). + +```bash +$ pip install --editable . +``` + +That's it. If you make some good ones, please consider submitting them as pull requests so everyone can benefit. + + + + +%prep +%autosetup -n census-data-downloader-0.0.36 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-census-data-downloader -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Thu May 18 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.36-1 +- Package Spec generated @@ -0,0 +1 @@ +95388754c7a8dc6193e595819240a3a4 census-data-downloader-0.0.36.tar.gz |
