Deputy Overwatch

Supervise our congressmen spendings.

Features

API with every congressman indemnifications budget provided in JSON format. Checkout the api queries documentation: wiki/Api

API Examples

• list all deputies

    /api/deputies/
  

• list indemnities, grouped by categories and deputies

    /api/indemnities/categories/deputies/
  

• list indemnities, grouped by categories and deputies, but only top5 deputies

    /api/indemnities/categories/deputies/?top=5
  

Dependencies

Various 3rd Party libraries are needed in order to run Deputy Overwatch. Checkout the Dependencies documentation: wiki/Dependencies

• Flask
• SQLAlchemy
• Flask-SQLAlchemy
• Flask-Runner
• Flask-Runner
• Flask-Migrate
• Faker
• factory_boy
• inflection
• xmltodict
• webargs

Installation

Deputy Overwatch is built using Flask, an open source Python library for interacting with HTTP. The following steps will require to install the tools listed below:

• Python 3.5
• pip

1. Clone from bitbucket (this will create a deputy-overwatch folder in the current directory)

    git clone https://bitbucket.org/diogolundberg/deputy-overwatch.git
   

2. [optional] Create a virtual environment. We suggest installing virtualenv with virtualenvwrapper. This allows python libraries to be installed easily and specifically on a per project basis.

   Once this is complete, run the following to initialize your environment.

    mkvirtualenv --python=python3 deputy-overwatch
    workon deputy-overwatch
   

3. Install the required Python libraries

    pip install -r requirements.txt
   

4. Create the database

   From the project's folder:
   
    python manage.py db upgrade
   

5. Scrape data to fill your database

   From the project's folder:
   
    python manage.py scrape
   

6. Run the site locally!

    python manage.py runserver
   

Contribution Guide

• Make sure to check where the database is being created(project's root) and get a SQLite client to check it!

• This project is set up to check pep8 offenses in a pipeline, install a good linter to save time

• Finally, the most important, run tests! Try to use some good practices like TDD.

Running tests

 python manage.py test

Check test coverage

 nosetests --with-coverage --cover-erase --cover-package=overwatch --cover-html