Welcome to PyPUMS’s documentation!

pypums

Build status Changelog License

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

or as a CLI

as a CLI

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}}
}