Python JavaScript HTML CSS Makefile
Clone or download

README.md

Olho Neles Code Health Build Status

Tool to monitor Brazilian legislators expenses while in the exercise of their mandates.

Install

  1. Clone the repository:

    git clone https://github.com/olhoneles/olhoneles.git
    
  2. Create a virtualenv:

    cd olhoneles
    mkvirtualenv olhoneles
    
  3. Install dependencies:

    make setup
    
  4. Create your database:

    make data
    
  5. Run it:

    make run
    
  6. Change default configs:

    If you would like to override some settings.py variables, like SECRET_KEY, DATABASES, ALLOWED_HOSTS, please create the olhoneles/local.config file.

Collecting the data

After setting up, you can collect one of the supported legislative houses (cmbh, almg, cmsp, senado) by using the collect command like this:

./manage.py collect <house>

You can add --debug after the name of the house to get a more verbose output. Note that the collection process happens in a transaction and that the expenses are not added to the main Expense table while the collection is running, so you will not see partial data in the site while collecting.

API

Yes, we have an API. The Olho Neles API lets you build tools using all data we have collected from legislative houses. All endpoints, parameters and error messages available to the Olho Neles API are docummented.

Contribute

Join us at the dev-mailing list and at #olhoneles on Freenode.

Fork the repository and send your pull-requests.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.