51 lines
1.4 KiB
Markdown
51 lines
1.4 KiB
Markdown
# Python Project Boilerplate
|
|
|
|
Welcome! This repository provides a minimal, well-structured starting point for new Python projects.
|
|
|
|
## What You Get
|
|
|
|
- `src/` package layout for application code
|
|
- `tests/` with placeholder unit tests
|
|
- `pyproject.toml` configured with placeholder metadata
|
|
- Ruff linting and formatting
|
|
- Pyright type checking
|
|
- Nox automation sessions (format, lint, typecheck, tests, docs, build)
|
|
- MkDocs configuration for documentation
|
|
- Dev container setup for consistent environments
|
|
|
|
## Getting Started
|
|
|
|
1. Clone or template this repository
|
|
2. Rename the package under `src/` to match your project
|
|
3. Update metadata in `pyproject.toml`, `README.md`, and this documentation
|
|
4. Create a virtual environment and install dependencies:
|
|
```bash
|
|
python -m venv .venv
|
|
source .venv/bin/activate
|
|
pip install -e .[dev]
|
|
```
|
|
5. Run the sample quality checks:
|
|
```bash
|
|
nox -s format lint typecheck tests
|
|
```
|
|
6. Launch the example CLI:
|
|
```bash
|
|
python -m boilerplate
|
|
```
|
|
|
|
## Customization Checklist
|
|
|
|
- [ ] Replace placeholders in documentation and configuration
|
|
- [ ] Add real dependencies to `pyproject.toml`
|
|
- [ ] Expand tests in `tests/`
|
|
- [ ] Remove this checklist when done
|
|
|
|
## Next Steps
|
|
|
|
- Add project-specific modules under `src/`
|
|
- Implement real CLI or application entry points
|
|
- Document usage, architecture, and development workflow
|
|
- Configure CI/CD pipelines as needed
|
|
|
|
Happy building!
|