Skip to content

Commit 7f2c035

Browse files
softiniosoftinio
committed
Initial Version
1 parent a778206 commit 7f2c035

14 files changed

Lines changed: 1806 additions & 0 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
test-and-lint:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v4
16+
17+
- name: Install Nix
18+
uses: cachix/install-nix-action@v31
19+
with:
20+
github_access_token: ${{ secrets.GITHUB_TOKEN }}
21+
22+
- name: Install dependencies
23+
run: nix develop --command uv sync
24+
25+
- name: Run linting
26+
run: nix develop --command runLint
27+
28+
- name: Run tests
29+
run: nix develop --command runTests
30+
31+
- name: Upload coverage reports
32+
uses: actions/upload-artifact@v4
33+
if: always()
34+
with:
35+
name: coverage-report
36+
path: htmlcov/
37+
retention-days: 7

‎.gitignore‎

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[codz]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py.cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# UV
98+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
#uv.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
#poetry.lock
109+
#poetry.toml
110+
111+
# pdm
112+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115+
#pdm.lock
116+
#pdm.toml
117+
.pdm-python
118+
.pdm-build/
119+
120+
# pixi
121+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122+
#pixi.lock
123+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124+
# in the .venv directory. It is recommended not to include this directory in version control.
125+
.pixi
126+
127+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128+
__pypackages__/
129+
130+
# Celery stuff
131+
celerybeat-schedule
132+
celerybeat.pid
133+
134+
# SageMath parsed files
135+
*.sage.py
136+
137+
# Environments
138+
.env
139+
.envrc
140+
.venv
141+
env/
142+
venv/
143+
ENV/
144+
env.bak/
145+
venv.bak/
146+
147+
# Spyder project settings
148+
.spyderproject
149+
.spyproject
150+
151+
# Rope project settings
152+
.ropeproject
153+
154+
# mkdocs documentation
155+
/site
156+
157+
# mypy
158+
.mypy_cache/
159+
.dmypy.json
160+
dmypy.json
161+
162+
# Pyre type checker
163+
.pyre/
164+
165+
# pytype static type analyzer
166+
.pytype/
167+
168+
# Cython debug symbols
169+
cython_debug/
170+
171+
# PyCharm
172+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174+
# and can be added to the global gitignore or merged into this file. For a more nuclear
175+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
176+
#.idea/
177+
178+
# Abstra
179+
# Abstra is an AI-powered process automation framework.
180+
# Ignore directories containing user credentials, local state, and settings.
181+
# Learn more at https://abstra.io/docs
182+
.abstra/
183+
184+
# Visual Studio Code
185+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
186+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
187+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
188+
# you could uncomment the following to ignore the entire vscode folder
189+
# .vscode/
190+
191+
# Ruff stuff:
192+
.ruff_cache/
193+
194+
# PyPI configuration file
195+
.pypirc
196+
197+
# Cursor
198+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
199+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
200+
# refer to https://docs.cursor.com/context/ignore-files
201+
.cursorignore
202+
.cursorindexingignore
203+
204+
# Marimo
205+
marimo/_static/
206+
marimo/_lsp/
207+
__marimo__/

‎.pre-commit-config.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
repos:
2+
- repo: https://github.com/facebook/pyrefly
3+
rev: main
4+
hooks:
5+
- id: pyrefly-typecheck
6+
- repo: https://github.com/astral-sh/ruff-pre-commit
7+
rev: v0.9.9
8+
hooks:
9+
- id: ruff
10+
types_or: [python, pyi, jupyter]
11+
args: [ --fix ]
12+
- id: ruff-format
13+
types_or: [python, pyi, jupyter]

‎.python-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.13

‎CLAUDE.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Development Commands
6+
7+
This project uses `uv` (a fast Python package manager) and Nix for development. Here are the essential commands:
8+
9+
**Note**: Always run `uv sync` first to ensure dependencies are installed.
10+
11+
### Running the Application
12+
```bash
13+
uv run pai
14+
```
15+
16+
### Testing
17+
```bash
18+
# Run all tests with coverage
19+
runTests # (Nix command)
20+
# or
21+
uv run pytest --cov=pai --cov-report=term-missing --cov-report=html
22+
23+
# Run a specific test
24+
uv run pytest tests/pai/test_main.py::test_specific_function
25+
```
26+
27+
### Linting and Formatting
28+
```bash
29+
# Run all linting/formatting (Nix command)
30+
runLint
31+
32+
# Or individually:
33+
uv run ruff format src # Format code
34+
uv run ruff check --fix src # Lint and auto-fix
35+
pyrefly check # Type checking
36+
37+
# Run pre-commit hooks
38+
pre-commit run --all-files
39+
```
40+
41+
### Dependency Management
42+
```bash
43+
uv sync # Install all dependencies
44+
uv pip install -e . # Install package in editable mode
45+
```
46+
47+
### CI/CD
48+
The project includes GitHub Actions workflow that automatically:
49+
- Runs tests and linting on all pull requests
50+
- Runs tests and linting on pushes to main branch
51+
- Uses Nix for consistent CI environment
52+
- Uploads test coverage reports as artifacts
53+
54+
## Architecture Overview
55+
56+
This is an AI-centric Python application with a clean, modular structure:
57+
58+
1. **Main Package**: `src/pai/` - The core application package ("Python AI")
59+
- Entry point: `src/pai/main.py:main` (accessed via `uv run pai`)
60+
- The main function logs initialization and returns a boolean status
61+
62+
2. **Configuration**: Modern Python project using:
63+
- `pyproject.toml` for all project metadata and dependencies
64+
- `uv.lock` for reproducible dependency management
65+
- Nix flakes for development environment consistency
66+
67+
3. **Key Architectural Patterns**:
68+
- Pydantic for data validation and settings management
69+
- Structured logging with structlog
70+
- Async-first design with httpx for HTTP operations
71+
- Type safety enforced through Basedpyright and Pyrefly
72+
73+
4. **AI/ML Integration Points**:
74+
- Anthropic Claude API integration
75+
- OpenAI API support
76+
- Hugging Face model hub access
77+
- Model Context Protocol (MCP) for AI interactions
78+
79+
## Development Environment
80+
81+
This project uses Nix for reproducible development environments. Enter the dev shell with:
82+
```bash
83+
nix develop
84+
```
85+
86+
The environment includes:
87+
- Python 3.13
88+
- All development tools (ruff, pytest, pyrefly, etc.)
89+
- Pre-configured pre-commit hooks
90+
- Environment file support (`.env`, `.test.env`, `.deploy.env`)
91+
92+
## Code Quality Standards
93+
94+
- **Line Length**: 120 characters (Ruff configuration)
95+
- **Type Checking**: Both Basedpyright and Pyrefly must pass
96+
- **Test Coverage**: Maintain test coverage with parallel structure in `tests/`
97+
- **Pre-commit**: All hooks must pass before commits

0 commit comments

Comments
 (0)