This readme only contains installation instructions for more information please refer to the full documentation

Installation

Requirements

• Python 3.5+
• Maria DB
• libxml
• libxslt
• zlib
• git
• libffi-dev
• qpdf for PDF generation
• An access to our Solr database
• An access to our Fedora repository

Those last two requirements mean that unless you spend time building yourself a Solr and Fedora instances, you can't really run this app locally if you're not part of Érudit.

On Ubuntu 18.04, requirements can be installed with:

$ sudo apt-get install -y python3-venv python3-dev mariadb-server libxml2-dev libxslt1-dev zlib1g-dev git libffi-dev libmariadbclient-dev build-essential qpdf

Clone the repository:

$ git clone https://github.com/erudit/eruditorg.git

Setup the virtualenv

With virtualenvwrapper, create a virtualenv with:

$ mkvirtualenv <your_virtualenv_name>

Then install development python dependencies in it:

$ pip-sync requirements-dev.txt

Database

then, you need databases:

$ mysql
MariaDB [(none)]> create database eruditorg character set utf8;
MariaDB [(none)]> create database restriction character set utf8;

Initial data

The easiest way to seed your development environment is to import a dump from the production server into your local database. Generating local data from scratch is possible, but its seldom done so this road is bumpy. To import a dump in mysql:

$ gzip -dc dump.sql.gz | mysql -u root -D eruditorg

To be able to restore production data, you will need to configure your mariadb server to use the Barracuda file format by adding these lines in your my.cnf:

[mysqld]
innodb_file_format = Barracuda 

Creating .env file

Copy .env.sample into .env and edit this file with credentials to Érudit's Solr and Fedora instances.

Django

Activate the virtualenv:

$ . env/bin/activate

Run the migrations:

$ python eruditorg/manage.py migrate

You can now run the development server

$ python eruditorg/manage.py runserver

Updating pip requirements

The requirements.txt file is generated with pip-tools from requirements.in. The reason for this is that we want to describe main dependencies manually (in requirements.in) but we want to manage transitive dependencies and pinning automatically.

To update requirements.txt, ensure you have pip-tools installed and run:

$ ./tools/update-requirements.sh

You should then have a requirements.txt with up-to-date dependency pinnings. You can run pip install -r requirements.txt to update your venv.

Documentation

The project's documentation is built with Sphinx

Building the documentation is optional. For this reason, sphinx is not listed in requirements.txt If you wish to build the documentation, you must first install sphinx in your virtualenv.

$ pip install sphinx

You will then be able to build the docoumentation using the Makefile in the docs directory:

$ make html

Running the tests

You can run the tests with pytest:

$ PYTHONPATH=".:./eruditorg/" pytest tests/

Black and flake8

Black is configured in pyproject.toml. You can run it with:

$ black eruditorg/ tests/

Flake8 is configured in .flake8. You can run it with:

# flake8 eruditorg/ tests/

Documentation

Please visit http://eruditorg.readthedocs.org/fr/latest/

Contributing patches

Please refer to CONTRIBUTING.md for contribution guidelines.

Additional information

If you have further questions or if you wish to discuss the project, please join us on #erudit on Freenode.