https://github.com/anapaulagomes/step

The first step to automate things; from a Markdown to a CLI
https://github.com/anapaulagomes/step

cli markdown

Last synced: 15 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/anapaulagomes/step
• Owner: anapaulagomes
• Created: 2023-05-26T17:09:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-15T18:18:54.000Z (4 months ago)
• Last Synced: 2024-10-04T16:26:04.419Z (about 1 month ago)
• Topics: cli, markdown
• Language: Python
• Homepage:
• Size: 79.1 KB
• Stars: 12
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# step

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

[![PyPI version](https://badge.fury.io/py/step.svg)](https://badge.fury.io/py/step)

[![Tests](https://github.com/anapaulagomes/step/actions/workflows/tests.yml/badge.svg)](https://github.com/anapaulagomes/step/actions/workflows/tests.yml)

## 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

```bash

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](https://python-poetry.org/) installed.

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