Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
70 lines (43 sloc) 1.72 KB

Contributing to Scholia

Source code an issue tracker

Scholia development is hosted at https://github.com/fnielsen/scholia.

Technology stack

Scholia is mainly based on

Getting started

  1. Clone Scholia repository from GitHub

    $ git clone https://github.com/fnielsen/scholia.git     # via HTTPS
    $ git clone git@github.com:fnielsen/scholia.git         # or via SSH
    
  2. Install required Python libraries:

    $ pip install -r requirements.txt   # either global
    $ pip install -r requirements.txt   # or locally

    On Debian 8/9 you need to install the packages python3, python3-pip, and python3-flask and use pip3:

    $ apt-get install python3 python3-pip python3-flask
    $ pip3 install -r requirements.txt
  3. Run Scholia functionality as script, e.g.:

    $ python -m scholia.query twitter-to-q fnielsen
    Q20980928
  4. Run Scholia locally as web application

    python runserver.py

Testing

Rudimentary testing and code style checking are implemented via tox. Before committing please run the following code in the main directory:

tox

The style is checked with flake8. Also follow the commit message recommendations, cf. Writing good commit messages.

You can’t perform that action at this time.