README.md

# EOASkripts
This is a set of scripts which forms the central part of the
conversion workflow in the Edition Open Access.

We currently accept and support manuscripts in two different formats:
LaTeX and DocX (as used in Microsoft Word).

![The EOA workflow](doc/eoa_intermediate_workflow.png)

# Installation

In order to provide a consistent environment we are using docker.
A set of python scripts is used for automatisation.
Installing and running the project without Docker or the scripts is possible, but not recommended. In this case you are on your own.

## Prerequisites

- Python 3
- Docker, Docker Compose

## Initialise the Repository

	$ ./scripts/init.py [--build]

This will pull remote repositories and resources, initialize the database, etc.
Force recreating the docker image by adding `--build` e.g. if `Dockerfile` or `requirements.txt` has changed.

## Run the Docker Container

	$ ./scripts/run.py

The container should now be up and running.

## Run Command in the Docker Container

	$ ./scripts/exec_in_container.py [-- CMD ...]

Follow your workflow by running the appropriate scripts to compile your publications (see chapter 'Workflow').
Inside the container you have a well defined environment with all necessary evil dependencies available.
Don't forget to stop the container when you are done.

## Stop the Docker Container

	$ ./scripts/stop.py

## Clean the Repository

	$ ./scripts/exit.py

This should remove all remote repositories and resources not part of this repository.
Docker images are not deleted though.

## Configuration

- Environment variables: see file `.env`

	These variables are available inside the `docker-compose.yaml` file and are also loaded into the python scripts.
	The file is created with default settings by the `init.py` script.

# Workflows

Compiling your documents involves following a workflow which can consist of several steps.
For all further explanations we assume you are in the docker container.

## The LaTeX workflow (TODO)

TODO

## The DocX workflow (TODO)

TODO

## Examplary workflow (TODO)

TODO