CLI tool to setup Python projects
Project description
catface s a Command Line Interface (CLI) tool that helps you create Python projects with best practices built-in. It uses cookiecutter under the hood to provide project templates that you can customize based on your needs.
Features
-
Documentation (MkDocs)
- Automatic API documentation
- Material design theme
- Ready-to-deploy structure
-
Docker Integration
- Multi-stage builds
- Production-ready configuration
- Python version specific base images
-
Development Tools
- Pre-commit hooks for code quality
- Ruff for fast linting and formatting
- Tox for testing across Python versions
Quick Start
# Install Catface
pip install catface
# Create a new project
catface my-awesome-project
Pre-configured Tox file
- Task automation: Using Tox we can automate repetitive tasks
- Test against multiple Python versions
- Environment management: Using Tox we can create different environments each with its dependencies
- Lint and format code using Ruff
# Cd inside your project
cd my-awesome-project
tox # runs all environments
tox -e <env_name> # running each environment individually by name
tox -p all # parallel execution
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file catface-0.1.4.tar.gz.
File metadata
- Download URL: catface-0.1.4.tar.gz
- Upload date:
- Size: 10.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7c9dd746aa926d95d22884443e02db2281a28b48546fca6419e47d0bcc346d2c
|
|
| MD5 |
34f2c1a959d249051534c73d9defd3da
|
|
| BLAKE2b-256 |
a597e4eb0b5d4bf6d8b3af52035eb054cdb364fdb13187d5b8f5fffe8c9967f3
|
File details
Details for the file catface-0.1.4-py3-none-any.whl.
File metadata
- Download URL: catface-0.1.4-py3-none-any.whl
- Upload date:
- Size: 13.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
55599238c3ed835b7c42f400f30f9be3f4dbcc8cf8cb2d78ef1df5cc978c4331
|
|
| MD5 |
517557e844ddf5f3b32f719ae4840bb1
|
|
| BLAKE2b-256 |
1c44f92b47ef8d961e3ce8df0d201ec0afc3a45482c9d9c5c8cca391879ba716
|