This is a project aimed at helping Americans make choices about retirement, including when to claim Social Security benefits.

• Status: Beta

• pip
• virtualenv
• virtualenvwrapper

• Django 1.6.11
• BeautifulSoup4
• Python-dateutil
• Requests
• lxml

• nose
• mock
• coverage

The tool is a Django module, intended to be installed in a larger Django project. But it can run on its own in a Mac or Linux environment, assuming you have the setup dependencies of pip, virtualenv and virtualenvwrapper installed. Here's how:

Go to where you want the project to be created, make a virtual environment, clone this repository (or your own fork of it) and install requirements and settings.

mkvirtualenv retirement
git clone https://github.com/cfpb/retirement.git
cd retirement
setvirtualenvproject
pip install -r requirements.txt
cp test_settings.py settings.py

Load the app's database tables and content.

python manage.py syncdb
python manage.py loaddata retiredata.json

Fire up a development server.

python manage.py runserver

The "Claiming Social Security" page should load at localhost:8000/claiming-social-security/.

• The app is set up to run inside consumerfinance.gov, so if you run it locally, some fonts may not load because of Cross-Origin Resource Sharing rules.
• The app sends http requests to the Social Security Administration's Quick Calculator to get benefit estimates for the chart.

• You can use nose to run the test suite and see code coverage information

nosetests --with-coverage --config=.coveragerc --cover-package retirement_api

If you find a bug or see a way to improve the project, we'd love to hear from you. Fork the project and send us a pull request with your changes.

1. TERMS
2. LICENSE
3. CFPB Source Code Policy