-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add CLAUDE.md for Claude Code guidance #63
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
albertotb
wants to merge
1
commit into
main
Choose a base branch
from
add-claude-md
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+60
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # CLAUDE.md | ||
|
|
||
| This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. | ||
|
|
||
| ## Project Overview | ||
|
|
||
| Python template for libraries and applications with Docker packaging. Uses `uv` for dependency management, `ruff` for linting/formatting, and `pytest` for testing. | ||
|
|
||
| ## Common Commands | ||
|
|
||
| ```bash | ||
| # Install uv and dependencies | ||
| make install | ||
|
|
||
| # Run tests | ||
| make test | ||
|
|
||
| # Run tests with optional markers | ||
| uv run pytest --optional | ||
|
|
||
| # Run a single test file | ||
| uv run pytest tests/test_trivial.py | ||
|
|
||
| # Run a single test | ||
| uv run pytest tests/test_trivial.py::test_print_version | ||
|
|
||
| # Lint and format | ||
| make ruff | ||
|
|
||
| # Run pre-commit hooks on all files | ||
| make hooks | ||
|
|
||
| # Run the API locally (port 7000) | ||
| uv run python template/api.py | ||
|
|
||
| # Build and run Docker container | ||
| make docker | ||
| ``` | ||
|
|
||
| ## Architecture | ||
|
|
||
| - `/template`: Main Python package | ||
| - `main.py`: CLI entry point using Typer, exposes version via `main` console script | ||
| - `api.py`: FastAPI application with `/` (version check) and `/predict` endpoints | ||
| - `/tests`: Pytest test suite | ||
| - `conftest.py`: Custom `--optional` flag for marking optional tests with `@pytest.mark.optional` | ||
|
|
||
| ## Code Style | ||
|
|
||
| - Python 3.9-3.12 compatible | ||
| - Use `from __future__ import annotations` for union type syntax (`A | B`) | ||
| - Docstrings follow NumPy convention | ||
| - Ruff rules: pycodestyle (E), Pyflakes (F), pyupgrade (UP), flake8-bugbear (B), flake8-simplify (SIM), isort (I), pydocstyle (D) | ||
| - mypy strict mode enabled for the `template` package | ||
|
|
||
| ## Dependencies | ||
|
|
||
| - Add dependencies: `uv add <package>` | ||
| - Add dev dependencies: `uv add --dev <package>` | ||
| - Upgrade all: `uv lock --upgrade` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
La duda que tengo, es parecida a la que puse en el otro repo.
En este CLAUDE.md hay cosas que deben permanecer en el CLAUDE.md de proyecto instanciado (como lo de docstrings estilo numpy); pero hay otras que deben ser cambiadas (como este /template). No se si hay forma de indicar esto o algo así