CONTRIBUTING.rst

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

• Python (>= 2.7)
• HTML with Bootstrap CSS
• JavaScript with jQuery and wikidata-sdk
• SPARQL to query the Wikidata Query Service

Getting started

1. Clone Scholia repository from GitHub

   $ git clone https://github.com/fnielsen/scholia.git     # via HTTPS
   $ git clone [email protected]: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.