fmartingr
/
jeeves
Archived
1
0
Fork 0
This repository has been archived on 2021-02-14. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Felipe Martin 670c058e3e
Added Sphinx docs
2019-10-03 18:13:34 +02:00
docs Added Sphinx docs 2019-10-03 18:13:34 +02:00
jeeves Autoregister tasks on tests 2019-10-03 18:09:58 +02:00
.env.example Fixed JEEVES_DEBUG in .env.example 2019-09-25 19:42:28 +02:00
.gitignore Added Sphinx docs 2019-10-03 18:13:34 +02:00
.pre-commit-config.yaml Initial proof of concept 2019-09-23 23:11:26 +02:00
Dockerfile Added docker-compose 2019-09-30 17:52:23 +02:00
Makefile Initial proof of concept 2019-09-23 23:11:26 +02:00
README.md Added Sphinx docs 2019-10-03 18:13:34 +02:00
docker-compose.yml Load .env on docker services 2019-09-30 18:45:00 +02:00
manage.py Formatting 2019-09-29 14:30:45 +02:00
poetry.lock Added Sphinx docs 2019-10-03 18:13:34 +02:00
pyproject.toml Added Sphinx docs 2019-10-03 18:13:34 +02:00
setup.cfg Added jeeves.cli for basic CLI interaction 2019-10-03 13:01:45 +02:00

README.md

Jeeves

Jeeves will take care of your boring tasks so you don't have to worry.

Python 3.7+

Documentation

Documentation is accesible and readable in the docs folder.

Running it

Using the cli

Jeeves provide a useful CLI to execute your flows in a very convenient way, for example. given a test flow:

// definition.json
{
    "name": "Test flow",
    "tasks": [
        {
            "name": "Say hello",
            "type": "jeeves.core.tasks.shell:ShellTask",
            "parameters": {
                "script": "#!/bin/bash\necho HELLO WORLD!"
            }
        }
    ]
}

You can run it using jeeves execute definition.json:

$ jeeves execute --output  definition.json
(i) Running flow from definition.json
=== Running flow: Test flow
ok! Running step [1/1]: Say hello
=== Full output:
HELLO WORLD

You can also run the same command from stdin using:

  • cat definition.json | jeeves execute --output -
  • jeeves execute --output - < definition.json

Contributing

TODO