18F / snap-api-prototype

No longer in active development. -- Work moved to: https://github.com/18f/snap-js-api-prototype. -- A prototype API to calculate SNAP eligibility. Available as a Python package or as a Web API.

Prototype: SNAP Financial Factors

This is a sketchpad prototyping repo being used by 18F's Eligibility APIs Initiative to explore the financial factors of SNAP eligibility.

⚠️ None of the eligibility rules expressed in this repository should be considered official interpretations of SNAP rules or policy. This is a sketchpad prototyping repo only. ⚠️

What does this do?

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

Using the API

Web and Python APIs

Our goal is to make this prototype available both as a downloadable Python package and as a web API.

See below for API documentation:

• Web API documentation
• Python API documentation

State coverage and modeling progress

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:

• SNAP modeling progress
• State-by-state API coverage

Developing the API

Environment

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.)

Install the dependencies

make install

Run all the tests

make check-all

Run locally

make serve

Deploy

This app includes a manifest.yml file with deploy configuration for Cloud.gov or another Cloud Foundry system.