Metadata-Version: 2.5
Name: jeskit
Version: 0.5.0
Summary: A verbose and advanced orchestrator for developers.
Author: Zaslon-Hivemind
License: MIT
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: rich>=13.0
Description-Content-Type: text/markdown

# Jeskit

## What is Jeskit?

Jeskit is a command running/orchestration utility that is built using Python, and is constantly recieving new updates!
Unlike many other alternatives, Jeskit is meant to be **Verbose**, **Simple**, and **clean**!

And if it doesn't have a feature/has a bug? Report it directly to issues!
(See below)

---

## Jeskit is, and is NOT:

**IS:**
* Command runner
* Command orchestrator
* A simpler alternative to many other projects
* Written by (As of writing this) a beginner Dev as a hobby!

**IS NOT:**
* A compiler
* Full build system
* Another piece to rice on your arch linux rice to be posted onto r/linux (Unless you REALLY want to)
* Maintained by a developer that is equal to the skills of Linus Torvalds, Terry A. Davis, or literally any dev that has existed longer than I have.
* A large, complex, and huge project.

Please take this as a hint before writing anything that could get you ratio'd on twitter.

---

## How to install?

Just simply type:
`pip install jeskit`

Extra download methods will be supported soon.

---

## Usage guide:

As of writing this (v0.5 release), there is only two real commands:
* `run`
* `version`

we'll be running deep into run.

#### How to format jeskit.toml

first, create `jeskit.toml`, exactly as spelt. Then, fill it up with Jesits (Basically a command). There is only three parameters:
* Name: The title of your Jesit, which is a toml table formatted like this: `[jesits.command]`, change command as needed.
* command: This is the exact terminal command that your jeskit.toml will do. Fill it below as a key-pair value.
* depends_on: an optional field that says what your Jesit depends on. Note that only one dependency can be placed per jesit as of now.

If you need a better example, here is a template:

```toml
[jesit.one]
command = "echo Hello World!"

[jesit.two]
command = "echo Goodbye World!"
depends_on = ["one"]
```

#### How to run a Jesit

As stated, a Jesit is just a command for Jeskit to run. As for how to do it... Just type:
`jeskit run [command]`

As simple as that!

## Current issues:
- If you check my todo, not everything is done! This will be fixed later.
- Note that I am a beginner in programming, and human, and of course, I may not understand every single thing about programming. So please be patient if you have an issue.
- Some cases give an unexpected error or a python traceback. Use this in a hacky way for now.

## How to contribute?

**If you have a bug or an issue:**

Report it into issues, as a bug report.

**If you have an request or a feature:**

Report it into issues, as a feature request.

**If you wanna give advice, talk, or recommend any changes that isn't directly a bug-fix, or a feature:**

Open up a discussion!

**If you wanna do a pull request:**

Open a PR. Please do include a detailed report on what changed, why did it change, and for what good? I'll be much more liklier to accept these.

## To friends that see this...

Dawg go back to scrolling on instagram reels.
