/ptdk

Webserver for Planemo Training Development Kit

Primary LanguagePythonMIT LicenseMIT

ptdk: Web server to create tutorial skeleton from workflow

It uses Planemo to create the skeleton of a tutorial for Galaxy Training Material from a public workflow on a public Galaxy instance.

Usage

Requirement

  • virtualenv

Prepare the environment

  • Create virtual environment:

    $ make create-venv
    

Run the server

  • Export the API for usegalaxy.eu, usegalaxy.org.au and usegalaxy.org.au as environment variables:

    $ export USEGALAXY_EU_APIKEY=<replace with correct API key>
    $ export USEGALAXY_FR_APIKEY=<replace with correct API key>
    $ export USEGALAXY_ORG_AU_APIKEY=<replace with correct API key>
    $ export USEGALAXY_ORG_APIKEY=<replace with correct API key>
    
  • Launch the server:

    $ make run
    
  • Browse it at http://127.0.0.1:5000/

  • Kill it with CTRL+C

Run the tests

  • Install the requirements:

    $ make setup
    
  • Run the tests:

    $ make test
    

Deploy to Heroku (https://ptdk.herokuapp.com/)

Automatically done when push to main

How is it working?

It uses:

  • Flask for the web server
  • Planemo to generate the skeleton from a workflow
  • Bulma to make it nice looking

Contributing

Please check the CONTRIBUTING file for details

Code of Conduct

Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms. See the CODE_OF_CONDUCT file.

License

ptdk is released under the MIT License. See the bundled LICENSE file for details.