Skip to content

Commit 8b69d95

Browse files
sync: update from python-copier-template (#79)
## Summary Automated sync from [python-copier-template](https://github.com/Komorebi-AI/python-copier-template). This PR was generated by rendering the copier template and comparing the output against this repository. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent eb79e07 commit 8b69d95

2 files changed

Lines changed: 1 addition & 59 deletions

File tree

CLAUDE.md

Lines changed: 0 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,5 @@
11
# CLAUDE.md
22

3-
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4-
5-
## Build and Development Commands
6-
7-
```bash
8-
make install # Install uv and prek hooks
9-
make test # Run pytest
10-
make ruff # Format and lint with ruff
11-
make hooks # Run prek on all files
12-
make upgrade # Upgrade all dependencies
13-
```
14-
15-
Run a single test:
16-
17-
```bash
18-
uv run pytest tests/test_file.py::test_name -v
19-
```
20-
21-
Run tests with optional marker:
22-
23-
```bash
24-
uv run pytest --optional
25-
```
26-
27-
### API Commands
28-
29-
Run the API locally:
30-
31-
```bash
32-
uv run python template/api.py
33-
```
34-
35-
Test API endpoint:
36-
37-
```bash
38-
make test-api # or: http localhost:7000
39-
```
40-
41-
### Docker Commands
42-
43-
```bash
44-
make docker # Build and run container
45-
make build # Build image only
46-
make debug # Run container interactively
47-
```
48-
49-
## Code Architecture
50-
51-
- `/template` - Main Python package
52-
- `main.py` - Entry point with version handling
53-
- `api.py` - FastAPI application with `/` and `/predict` endpoints
54-
- `/tests` - Pytest test files
55-
- `/data` - Data directory
56-
57-
## Conventions
58-
593
- Uses `uv` for dependency management (not pip)
604
- Run any command with `uv run <command>`
615
- Add dependencies: `uv add <package>` or `uv add --dev <package>`
62-
- Docstrings follow NumPy convention
63-
- Ruff handles both linting and formatting

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)