datamade/occrp-timeline-tool

Name: occrp-timeline-tool

Owner: datamade

Description: Help reporters organize and analyze data about sequential events and related data

Created: 2017-06-23 14:49:30.0

Updated: 2017-11-01 08:38:20.0

Pushed: 2017-09-22 20:37:54.0

Homepage:

Size: 399

Language: Python

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

occrp-timeline-tool

The OCCRP Timeline Tool helps reporters capture, organize, and view sequences of events and how they relate to networks of organizations, people, and sources.

Get started

To get started, run the following commands in your shell:

one the repo
clone git@github.com:datamade/occrp-timeline-tool.git
ccrp-timeline-tool

We recommend using virtualenv and virtualenvwrapper for working in a virtualized development environment. Learn about how to set up virtualenv.

Then, do the following in your bash profile:

rtualenv occrp
install -r requirements.txt

At this point, you successfully installed several packages onto your virtual environment. If you want to see what lives inside the “occrp” virtualenv, then simply type:

freeze

And remember, whenever you want to use this virtual environment (and all its installed modules), run:

on occrp
Setup

We use DataMade's Flask App Template as a blueprint for the site framework.

Copy the app_config.py.example:

pp_config.py.example
config.py

Update these variables:

SER = ''
W = ''
OST = ''
ORT = ''
AME = 'occrp'

The DB_USER and DB_PW most likely will remain an empty string, for local development. Likewise, DB_HOST might be “localhost,” and DB_PORT may be “5432.”

Then, create your database, and run our custom script to generate tables:

tedb occrp
on init_db.py

We use Alembic and SQLAlchemy to track migrations and to update the database.

You might make modifications to the model(s). If so, create a new migration:

bic revision --autogenerate -m "Add first_name first to Person model"

Then, run the migration:

bic upgrade head
Team

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.