create-pypi-cli 0.1.0

# Welcome to your new Python CLI project! This project was generated...

Welcome to your new Python CLI project!

This project was generated using the create-pypi-cli tool.

[](https://github.com/lguibr/create-pypi-cli /actions) [](https://pypi.org/project/create-pypi-cli /) [](https://pypi.org/project/create-pypi-cli /) [](https://github.com/lguibr/create-pypi-cli /blob/main/LICENSE)

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:

1. Clone the repository:

   git clone https://github.com/lguibr/create-pypi-cli .git
   

2. Install the development dependencies:

   pip install -r requirements.txt
   

3. Install the pre-commit hooks:

   pre-commit install
   

4. Customize the project:

   • Update the setup.py file with your project's metadata and dependencies.
   • Modify the CLI template in your_project_name/cli.py according to your application's needs.
   • Add your project's dependencies to the requirements.txt file.

5. Start coding!

   Make your changes and commit them, following the pre-commit hooks for code formatting and quality checks.

6. 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!

---