farningcode-cli (0.1.0)
Installation
pip install --index-url About this package
Add your description here
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:
pip install uv
or directly from the source: astral.sh/uv
Usage
After installing uv, you can initialize it using the following command:
uv init
to add a new component, use the following command:
uv add <component_name>
Execute the following command to run uv:
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.
uvx ruff check
To format your Python code using ruff:
uvx ruff format
for typechecking your Python code using ty:
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>.