This is a sketchpad prototyping repo being used by 18F's Eligibility APIs Initiative to explore the financial factors of SNAP eligibility.
This prototype SNAP API calculates a household's estimated eligibility for the SNAP program. The API accepts inputs about a household and returns the following:
- an estimate of that household's SNAP eligibility
- an estimated benefit amount
- an explanation of the logic behind the API's decision-making
- a link to a state website where a household could apply for SNAP
Our goal is to make this prototype available both as a downloadable Python package and as a web API.
See below for API documentation:
The API does not cover every state or every facet of SNAP eligibility at this time.
See below for more detail on state coverage and SNAP modeling progress:
To run the project locally, you will need:
- Python 3.8.1.
- Pipenv, for installing and managing dependencies.
- Pyenv, for managing Python versions. (Optional but recommended.)
make install
make check-all
make serve
This app includes a manifest.yml
file with deploy configuration for Cloud.gov or another Cloud Foundry system.