https://github.com/datamade/occrp-timeline-tool
Help reporters organize and analyze data about sequential events and related data
https://github.com/datamade/occrp-timeline-tool
Last synced: 4 months ago
JSON representation
Help reporters organize and analyze data about sequential events and related data
- Host: GitHub
- URL: https://github.com/datamade/occrp-timeline-tool
- Owner: datamade
- License: mit
- Created: 2017-06-23T14:49:30.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-02T03:00:10.000Z (over 6 years ago)
- Last Synced: 2025-09-11T10:32:47.354Z (10 months ago)
- Language: Python
- Homepage:
- Size: 402 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# occrp-timeline-tool
The [OCCRP Timeline Tool](https://occrp.datamade.us) 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:
```bash
# Clone the repo
git clone git@github.com:datamade/occrp-timeline-tool.git
cd occrp-timeline-tool
```
We recommend using [virtualenv](https://virtualenv.readthedocs.io/en/latest/)
and
[virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/install.html)
for working in a virtualized development environment. [Learn about how to set up
virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/).
Then, do the following in your bash profile:
```bash
mkvirtualenv occrp
pip 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:
```bash
pip freeze
```
And remember, whenever you want to use this virtual environment (and all its installed modules), run:
```bash
workon occrp
```
## Setup
We use DataMade's [Flask App Template](https://github.com/datamade/flask_app_template) as a blueprint for the site framework.
Copy the `app_config.py.example`:
```bash
cp app_config.py.example
app_config.py
```
Update these variables:
```bash
DB_USER = ''
DB_PW = ''
DB_HOST = ''
DB_PORT = ''
DB_NAME = '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:
```bash
createdb occrp
python init_db.py
```
We use [Alembic](http://alembic.zzzcomputing.com/en/latest/index.html) and SQLAlchemy to track migrations and to update the database.
You might make modifications to the model(s). If so, create a new migration:
```bash
alembic revision --autogenerate -m "Add first_name first to Person model"
```
Then, run the migration:
```bash
alembic upgrade head
```
## Team
* Regina Compton
* Eric Van Zanten