Welcome to your new Python CLI project!
This project was generated using the create-pypi-cli tool.
About This Project
This project provides a solid foundation for building a Python CLI application. It comes with a pre-configured structure and essential files to help you get started quickly.
Features
- Clean and organized project structure
- GitHub Actions workflow for linting, type checking, and publishing to PyPI
- Pre-commit hooks for code formatting and quality checks using Black, Flake8, and Mypy
- Consistent import ordering with isort
- Basic CLI template using the Click library
Getting Started
To start developing your CLI application, follow these steps:
-
Install
create-pypi-clipip install create-pypi-cli
-
Create a new CLI project with a predefined CI with formatting/linting/typecheck/bump-version and publish at pypi
create-pypi-cli my-cli-project && cd my-cli-project
-
Customize the project:
- Update the
setup.pyfile with your project's metadata and dependencies. - Modify the CLI template in
your_project_name/cli.pyaccording to your application's needs. - Add your project's dependencies to the
requirements.txtfile.
- Update the
-
Start coding!
Make your changes and commit them, following the pre-commit hooks for code formatting and quality checks.
-
Push your changes and create a pull request.
Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
License
This project is licensed under the MIT License. See the LICENSE file for more information.
Credits
This project was generated using the create-pypi-cli tool, created by Luis Guilherme.
Feel free to customize this README further to provide more specific details about your CLI application, its usage, and any additional information that would be helpful for users and contributors.
Happy coding!
1 maintainer
Metadata
1 maintainer
Release files for create-pypi-cli 0.2.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| create-pypi-cli-0.2.6.tar.gz | 5.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| create_pypi_cli-0.2.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.0 kB
Release files / create-pypi-cli-0.2.6.tar.gz
| Download URL | create-pypi-cli-0.2.6.tar.gz |
|---|---|
| Size | 5.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e3c66c06127e26bfd8b86ffe8cbed8cf7d8e20f43969a3eee8363595a24ea4f1
|
|
BLAKE2b-256 checksum How to use checksums |
d33b951adc2ccc10c9cfd58cf32c15307b072859abd983d799b7acd23baaf804
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
Release files / create_pypi_cli-0.2.6-py3-none-any.whl
| Download URL | create_pypi_cli-0.2.6-py3-none-any.whl |
|---|---|
| Size | 8.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8567a84dc1057df7438a1ed9587b24dd60d1c42262f1fe27f5552f96fb539e3c
|
|
BLAKE2b-256 checksum How to use checksums |
d1d10db8076cd577116ad03c613b0bd5f3d15f8a9c25ba759c761319b3bcdd04
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
