step

The first step to automate things; from a Markdown into a CLI

The rationale behind this

There are so many manual tasks out there, most of them made of innumerous steps. Whenever someone thinks about automating them or even proposing this to their team, it sounds like a Herculean task.

What if we turn a checklist into a CLI and turn a gigantic process into something more feasible?

How to use it

step path-to/YOUR-MARKDOWN.md

Your markdown checklist will turn into a functioning CLI. There you will also find the Step object. You can add to it a callback function and smoothly migrate from a manual to automated approach.

A functional example will come soon.

About the markdown

A few assumptions are made about the Markdown format:

• the first head and paragraph are general descriptions, so they are used as name and description for the generated CLI
• to avoid nested sub steps in the alpha version of this lib, sub steps are created until the second level; the remaining levels are rendered as Markdown code

Development

First, you're going to need Python 3.10+. Then, poetry installed.

This project is in its alpha version, so there is more documentation to come.