Generator - Serviced-based version of CWL generator

Prerequisites

1. Python 3.
2. Docker (machine).

Development

Install and Run

Generator

1. Initialise a virtual environment, and activate:

python -m venv .venv
. .venv/bin/activate

2. Install dependencies:

pip install -r requirements.txt

3. Run generator:

python main.py

Deployment

1. Deployment is via Docker. If using remote machine, ensure it is activated:

docker context use [machine-name]

Staging

1. From the root directory, build container:

docker compose -f docker-compose.dev.yml build

2. Run container:

docker compose -f docker-compose.dev.yml up -d

Production

1. From the root directory, build container:

docker compose build

2. Run container:

docker compose up -d

Tests

Development

1. Run all tests:

python -m unittest

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

kclhi

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

• python-cwlgen.
• cwlviewer.