![Binder](https://mybinder.org/badge_logo.svg)
pypums
![License](https://img.shields.io/github/license/chekos/pypums)
Download Public Use Micro Sample (PUMS) data files from the US Census Bureau's FTP server.
Usage
To use PyPUMS in a project:
![on a jupyter notebook](https://github.com/chekos/pypums/blob/main/docs/static/usage.gif?raw=true)
or as a CLI
![as a CLI](https://github.com/chekos/pypums/blob/main/docs/static/cli.gif?raw=true)
Installation
Install this library using pip
:
pip install pypums
Usage
Usage instructions go here.
Development
To contribute to this library, first checkout the code. Then create a new virtual environment:
cd pypums
python -m venv venv
source venv/bin/activate
Or if you are using pipenv
:
pipenv shell
Now install the dependencies and test dependencies:
pip install -e '.[test]'
To run the tests:
pytest
📃 Citation
@misc{pypums,
author = {chekos},
title = {Download Public Use Micro Sample (PUMS) data files from the US Census Bureau's FTP server.},
year = {2020},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/chekos/pypums}}
}