Metadata-Version: 2.4
Name: pampa
Version: 0.1.0
Summary: A AI cli agent, for educational and testing purposes
Author-email: Xavier Petit <nuxion@gmail.com>
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# pampa

[![PyPI - Version](https://img.shields.io/pypi/v/pampa.svg)](https://pypi.org/project/pampa)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pampa.svg)](https://pypi.org/project/pampa)

-----

## Description

This is a template used to start python projects. 

It can be used as if clonning the git repository, or using degit:

```console
degit https://github.com/nuxion/python-template <your-project-name>
```

After that run `rename.sh` script to refactor folders and names to the new one:

```console
./rename.sh <your-project-name>
```

## Features

- Makefile for common tasks
- Sphinx 
- pytest
- `.gitignore` for python + nodejs projects + emacs + vim + vscode (using topal gitignore generation tool)
- jupyter as optional dependency + jupytext
- linting tools

## Dependencies

Dependencies are handled by [uv->dependencies](https://docs.astral.sh/uv/concepts/projects/dependencies/#changing-dependencies)

Adding a main dependency:

```
uv add flask
```

Add dev dependency

```
uv add --dev ruff
```

Fresh install: 
```
uv sync --locked
```

Export:
```
uv export --format requirements-txt
```

## References

- https://waylonwalker.com/hatch-version/

## License

`pampa` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
