Metadata-Version: 2.4
Name: farningcode-cli
Version: 0.1.0
Summary: Add your description here
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.34.2
Requires-Dist: textual>=8.2.8

# Farning
A coding Harness for any API, that supports:
- OpenAI Endpoints
- groq (Comming Soon)
- Anthropic (Coming Soon)

Supported tools: 
- Read File
- Write File
- Delete File
- Execute Command

## Bundles
Bundels are different UIs for FarningCode, like CLI, in development the core Package gets copied in the 

## Installation

You can install uv using pip:

```bash
pip install uv
```

or directly from the source:
[astral.sh/uv](https://astral.sh/uv)

## Usage

After installing uv, you can initialize it using the following command:

```bash
uv init
```

to add a new component, use the following command:

```bash
uv add <component_name>
```

Execute the following command to run uv:

```bash
uv run main.py
```

## Linting

To lint your Python code using ruff and typecheck using ty, execute the following commands:


To lint your Python code using ruff.
```bash
uvx ruff check
```

To format your Python code using ruff:

```bash
uvx ruff format
```

for typechecking your Python code using ty:

```bash
uvx ty check
```

## CiCD

The Linting and typechecking is also integrated into the CI/CD pipeline to ensure code quality before merging changes. This setup uses Woodpecker CI. The Ci/CD workflow will automatically run the linting and typechecking steps defined in the `.woodpecker.yml` configuration file. 

DISCLAIMER: The Ci/CD workflow just works if a uv init was executed in the repository beforehand. And at least one component has been added using `uv add <component_name>`.
