⦿ docker.pygentic_ai
---
## 🚀 Getting Started
### 🌟 Prerequisites
This project requires the following dependencies:
- **Programming Language:** Python
- **Package Manager:** Pip, Uv
- **Container Runtime:** Docker
### ⚡ Installation
Build Pygentic-AI from the source and intsall dependencies:
1. **Clone the repository:**
```sh
❯ git clone https://github.com/fsecada01/Pygentic-AI
```
2. **Navigate to the project directory:**
```sh
❯ cd Pygentic-AI
```
3. **Install the dependencies:**
**Using [docker](https://www.docker.com/):**
```sh
❯ docker build -t fsecada01/Pygentic-AI .
```
**Using [pip](https://pypi.org/project/pip/):**
```sh
❯ pip install -r core_requirements.txt, dev_requirements.txt
```
If this fails due to platform-specific issues, try this instead:
```sh
❯ pip install -r core_requirements.in, dev_requirements.in
```
**Using [uv](https://docs.astral.sh/uv/):**
```sh
❯ uv sync --all-extras --dev
```
### 🔆 Usage
Run the project with:
**Using [docker](https://www.docker.com/):**
```sh
docker run -it {image_name}
```
**Using [pip](https://pypi.org/project/pip/):**
```sh
python {entrypoint}
```
**Using [uv](https://docs.astral.sh/uv/):**
```sh
uv run python {entrypoint}
```
### 🌠 Testing
Pygentic-ai uses the {__test_framework__} test framework. Run the test suite with:
**Using [pip](https://pypi.org/project/pip/):**
```sh
pytest
```
**Using [uv](https://docs.astral.sh/uv/):**
```sh
uv run pytest tests/
```
---
## 🌻 Roadmap
- [X] **`Task 1`**: Bootstrap a minimal application build
- [ ] **`Task 2`**: Implement DB Backend with PostgreSQL
- [ ] **`Task 3`**: Integrate user auth and group controls
---
## 🤝 Contributing
- **💬 [Join the Discussions](https://github.com/fsecada01/Pygentic-AI/discussions)**: Share your insights, provide feedback, or ask questions.
- **🐛 [Report Issues](https://github.com/fsecada01/Pygentic-AI/issues)**: Submit bugs found or log feature requests for the `Pygentic-AI` project.
- **💡 [Submit Pull Requests](https://github.com/fsecada01/Pygentic-AI/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your github account.
2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
```sh
git clone https://github.com/fsecada01/Pygentic-AI
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to github**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph
---
## 📜 License
Pygentic-ai is protected under the [LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.
---
## ✨ Acknowledgments
- Credit `contributors`, `inspiration`, `references`, etc.
---
# PYGENTIC-AI
Built with the tools and technologies:
