Notebooks from Operação Serenata de Amor
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Improve issue and pull request template Dec 12, 2017
data Updates README.md and getting-started.md, adds data/ folder Oct 22, 2018
notebooks moves jupyter_notebook_config.py to project root Oct 22, 2018
.gitattributes Ignore HTML and PY files in Linguist Jul 22, 2017
.gitignore Move notebooks to research folder Jul 29, 2017
.travis.yml Merge branch 'master' into update-travis Oct 23, 2018
Dockerfile Adds updated Dockerfile Oct 22, 2018
LICENSE A new home for the notebooks Oct 3, 2018
README.md Updating references to nbviewer and binder. Oct 23, 2018
docker-compose.yml Swap build key for pre-existing image key Oct 26, 2018
getting-started.md
jupyter_notebook_config.py Clean up on some configurations and md files. Oct 23, 2018
requirements.txt Removes .pyup.yml Oct 22, 2018

README.md

Table of Contents

Notebooks from Operação Serenata de Amor

Binder

What

Operação Serenata de Amor has been acknowledged as a great AI project in Brazil and other countries. It has become not only a project to audit public expenses but also a space of sharing and collaboration. During its history, Serenata has had many people devoted to exploring its datasets through experimental notebooks which could possibly become a Rosie's classifier.

These notebooks from multiple authors are rich assets from which people can learn about data science, Python third-party libraries and core functions, as well as gather ideas for their own investigations.

Notebooks have been removed from the main repo, but with this exploratory and educative mindset, the team republishes the notebooks in this repo, also re-opening the space for collaboration and learning. Make yourself at home, you can read notebooks and share your own.

How

To read

  • You can clone this repo by typing on your console:
$ git clone https://github.com/okfn-brasil/notebooks.git
  • Alternatively you can download all the notebooks clicking the green "Clone or download" button on your right and choosing "Download ZIP".

  • Alternatively you can launch in binder.

This provides a simple and disposable environment to run and visualize notebooks. Don't use that as your development environment and definitely don't add your credentials on this environment.

To download the datasets

We use serenata toolbox to download or generate the datasets. To install and use the toolbox just checkout the toolbox's guide.

To collaborate

Fork this repo and clone it. Then commit a new branch with your notebook and PR us. The files will be reviewed by @jtemporal and @rodolfo-viana.

If you are a newcomer or just confused about what to do, read getting-started.md.

Please remember to export a .py and .html to facilitate the review process. There's a sample config file at notebooks/jupyter_notebook_config.py to make Jupyter export these files automatically.

Reminder

The notebooks are available here for educational purposes. So please do not feel ashamed of commenting every step of your analysis, ok? Overusing documentation is better than no documentation at all.