mirror of
https://github.com/fsecada01/Pygentic-AI.git
synced 2025-06-16 03:56:03 +00:00
PYGENTIC-AI
Built with the tools and technologies:
☀️ Table of Contents
- ☀ ️ Table of Contents
- 🌞 Overview
- 🔥 Features
- 🌅 Project Structure 4.1. 🌄 Project Index
- 🚀 Getting Started 5.1. 🌟 Prerequisites 5.2. ⚡ Installation 5.3. 🔆 Usage 5.4. 🌠 Testing
- 🌻 Roadmap
- 🤝 Contributing
- 📜 License
- ✨ Acknowledgments
🌞 Overview
🔥 Features
❯ REPLACE-ME
🌅 Project Structure
└── Pygentic-AI/
├── .github
│ └── workflows
├── bin
│ ├── build.sh
│ ├── linux_build.sh
│ ├── python_build.sh
│ └── start.sh
├── compose.yaml
├── core_requirements.in
├── core_requirements.txt
├── dev_requirements.in
├── dev_requirements.txt
├── docker
│ ├── celery
│ └── pygentic_ai
├── Dockerfile
├── pyproject.toml
├── README.md
├── src
│ ├── app.py
│ ├── backend
│ ├── cworker.py
│ └── frontend
└── uv.lock
🌄 Project Index
PYGENTIC-AI/
__root__
⦿ __root__
File Name Summary compose.yaml Code>❯ REPLACE-ME core_requirements.in Code>❯ REPLACE-ME core_requirements.txt Code>❯ REPLACE-ME dev_requirements.in Code>❯ REPLACE-ME dev_requirements.txt Code>❯ REPLACE-ME Dockerfile Code>❯ REPLACE-ME pyproject.toml Code>❯ REPLACE-ME
bin
⦿ bin
File Name Summary build.sh Code>❯ REPLACE-ME linux_build.sh Code>❯ REPLACE-ME python_build.sh Code>❯ REPLACE-ME start.sh Code>❯ REPLACE-ME
src
⦿ src
File Name Summary app.py Code>❯ REPLACE-ME cworker.py Code>❯ REPLACE-ME backend
frontend
⦿ src.frontendtemplates
⦿ src.frontend.templates
File Name Summary home.html Code>❯ REPLACE-ME result.html Code>❯ REPLACE-ME status.html Code>❯ REPLACE-ME components
⦿ src.frontend.templates.componentsforms
⦿ src.frontend.templates.components.forms
File Name Summary Form.jinja Code>❯ REPLACE-ME Search.jinja Code>❯ REPLACE-ME main
⦿ src.frontend.templates.components.main
File Name Summary base.html Code>❯ REPLACE-ME Base.jinja Code>❯ REPLACE-ME footer.html Code>❯ REPLACE-ME Footer.jinja Code>❯ REPLACE-ME header.html Code>❯ REPLACE-ME Header.jinja Code>❯ REPLACE-ME nav.html Code>❯ REPLACE-ME Nav.jinja Code>❯ REPLACE-ME Scripts.jinja Code>❯ REPLACE-ME Stylesheets.jinja Code>❯ REPLACE-ME style_sheets.html Code>❯ REPLACE-ME snippets
⦿ src.frontend.templates.components.snippets
File Name Summary Css.jinja Code>❯ REPLACE-ME js.html Code>❯ REPLACE-ME Js.jinja Code>❯ REPLACE-ME NavbarBrand.jinja Code>❯ REPLACE-ME NavbarMenu.jinja Code>❯ REPLACE-ME Result.jinja Code>❯ REPLACE-ME ResultEntry.jinja Code>❯ REPLACE-ME Spinner.jinja Code>❯ REPLACE-ME StatusResult.jinja Code>❯ REPLACE-ME
.github
⦿ .githubworkflows
⦿ .github.workflows
File Name Summary bandit.yml Code>❯ REPLACE-ME docker-image.yml Code>❯ REPLACE-ME
docker
⦿ dockercelery
⦿ docker.celery
File Name Summary start.sh Code>❯ REPLACE-ME pygentic_ai
⦿ docker.pygentic_ai
File Name Summary build.sh Code>❯ REPLACE-ME python_build.sh Code>❯ REPLACE-ME python_start.sh Code>❯ REPLACE-ME
🚀 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:
-
Clone the repository:
❯ git clone https://github.com/fsecada01/Pygentic-AI -
Navigate to the project directory:
❯ cd Pygentic-AI -
Install the dependencies:
Using docker:
```sh
❯ docker build -t fsecada01/Pygentic-AI .
```
Using 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:
```sh
❯ uv sync --all-extras --dev
```
🔆 Usage
Run the project with:
Using docker:
docker run -it {image_name}
Using pip:
python {entrypoint}
Using uv:
uv run python {entrypoint}
🌠 Testing
Pygentic-ai uses the {test_framework} test framework. Run the test suite with:
Using pip:
pytest
Using uv:
uv run pytest tests/
🌻 Roadmap
Task 1: Bootstrap a minimal application buildTask 2: Implement DB Backend with PostgreSQLTask 3: Integrate user auth and group controls
🤝 Contributing
- 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
- 🐛 Report Issues: Submit bugs found or log feature requests for the
Pygentic-AIproject. - 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.
Contributing Guidelines
- Fork the Repository: Start by forking the project repository to your github account.
- Clone Locally: Clone the forked repository to your local machine using a git client.
git clone https://github.com/fsecada01/Pygentic-AI - Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x - Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear message describing your updates.
git commit -m 'Implemented new feature x.' - Push to github: Push the changes to your forked repository.
git push origin new-feature-x - Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
- 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 License. For more details, refer to the LICENSE file.
✨ Acknowledgments
- Credit
contributors,inspiration,references, etc.