Initial commit
This commit is contained in:
55
{{cookiecutter.project_slug}}/README.md
Normal file
55
{{cookiecutter.project_slug}}/README.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# {{ cookiecutter.project_name }}
|
||||
|
||||
{{ cookiecutter.description }}
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install {{ cookiecutter.project_slug }}
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
This project uses `uv` for dependency management and the following tools:
|
||||
|
||||
### Setup
|
||||
```bash
|
||||
uv sync
|
||||
```
|
||||
|
||||
### Code Quality
|
||||
- **Ruff**: Linting and formatting
|
||||
```bash
|
||||
uv run ruff check --fix
|
||||
uv run ruff format
|
||||
```
|
||||
|
||||
- **MyPy**: Type checking
|
||||
```bash
|
||||
uv run mypy .
|
||||
```
|
||||
|
||||
### Testing
|
||||
```bash
|
||||
uv run pytest
|
||||
```
|
||||
|
||||
### Version Management
|
||||
- **bump-my-version**: Automated version bumping with git tags
|
||||
```bash
|
||||
uv run bump-my-version bump patch # {{ cookiecutter.version }} → 0.1.1
|
||||
uv run bump-my-version bump minor # {{ cookiecutter.version }} → 0.2.0
|
||||
uv run bump-my-version bump major # {{ cookiecutter.version }} → 1.0.0
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```python
|
||||
from {{ cookiecutter.package_name }} import hello
|
||||
|
||||
print(hello())
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see LICENSE file for details.
|
||||
Reference in New Issue
Block a user