Welcome to acs_download’s documentation!

ACS Download

Download American Community Survey (ACS) complete Public Use Micro Sample (PUMS) data files from census FTP server.

• Free software: MIT license
• Documentation: https://acs-download.readthedocs.io.

Usage

import acs_download as acs

acs.get_data(
    year = 2017,
    state = 'California',
    download_path = '../data/raw/',
    extract = True,
    extract_path = '../data/interim/',
)

This will download ACS PUMS data file of California to your ../data/raw/ folder and extract it to ../data/interim/ folder.

acs_download uses pypi package us, which uses jellyfish, to handle state input so you can use variations

example of usage on Jupyter Lab

example of usage on command line

Features

• TODO

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install acs_download, run this command in your terminal:

$ pip install acs_download

This is the preferred method to install acs_download, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for acs_download can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/chekos/acs_download

Or download the tarball:

$ curl  -OL https://github.com/chekos/acs_download/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use acs_download in a project:

.. code:: python

import acs_download as acs

acs.get_data(

year = 2017, state = ‘California’, download_path = ‘../data/raw/’, extract = True, extract_path = ‘../data/interim/’,

)

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/chekos/acs_download/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

acs_download could always use more documentation, whether as part of the official acs_download docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/chekos/acs_download/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up acs_download for local development.

1. Fork the acs_download repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/acs_download.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv acs_download
   $ cd acs_download/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 acs_download tests
   $ python setup.py test or py.test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/chekos/acs_download/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_acs_download

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

• Sergio Sánchez Zavala <sergio@cimarron.io>

Contributors

None yet. Why not be the first?

History

0.1.0 (2019-04-10)

• First release on PyPI.

Indices and tables

• Index
• Module Index
• Search Page