|
| 1 | +# Setups Python |
| 2 | + |
| 3 | +**Setups Python** is a Python CLI tool to dynamically generate `setup.py` for Python projects. This tool allows you to configure important project details, such as dependencies, license types, classifiers, and more, through a simple command-line interface. |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +- Automatically generate a `setup.py` file for your Python project. |
| 8 | +- Configure project version, description, license, dependencies, and more. |
| 9 | +- Choose from a wide range of open-source licenses. |
| 10 | +- Customize the setup process with URLs, classifiers, and other metadata. |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +You can install `setups` from PyPI using pip: |
| 15 | + |
| 16 | +```bash |
| 17 | +pip install setups |
| 18 | +``` |
| 19 | + |
| 20 | +## Usage |
| 21 | + |
| 22 | +To generate a `setup.py` for your project, use the following command: |
| 23 | + |
| 24 | +```bash |
| 25 | +setup new <project_name> |
| 26 | +``` |
| 27 | + |
| 28 | +You'll be prompted for the following information: |
| 29 | + |
| 30 | +- Project version |
| 31 | +- Short and long descriptions |
| 32 | +- Author name and email |
| 33 | +- License type (MIT, GPL, etc.) |
| 34 | +- Minimum Python version required |
| 35 | +- List of dependencies and test dependencies |
| 36 | +- Project URL, bug tracker URL, and documentation URL |
| 37 | +- Classifiers for the project |
| 38 | + |
| 39 | +## Example |
| 40 | + |
| 41 | +```bash |
| 42 | +$ setup new my-awesome-project |
| 43 | +Version (e.g., 0.1.0): 0.1.0 |
| 44 | +Short project description: A cool project |
| 45 | +Long description (use content from your README.md): This project is amazing. |
| 46 | +Author name: John Doe |
| 47 | +Author email: johndoe@example.com |
| 48 | +License type (MIT, GPL-3.0, etc.): MIT |
| 49 | +Minimum Python version required (e.g., 3.8): 3.8 |
| 50 | +Comma-separated list of dependencies (leave empty for none): numpy, requests |
| 51 | +Comma-separated list of test dependencies (leave empty for none): pytest |
| 52 | +Project URL (e.g., GitHub URL): https://github.com/johndoe/my-awesome-project |
| 53 | +Bug tracker URL: https://github.com/johndoe/my-awesome-project/issues |
| 54 | +Documentation URL: https://github.com/johndoe/my-awesome-project/wiki |
| 55 | +Comma-separated list of classifiers: Development Status :: 5 - Production/Stable, Intended Audience :: Developers |
| 56 | +``` |
| 57 | + |
| 58 | +## License |
| 59 | + |
| 60 | +MIT License. See the [LICENSE](LICENSE) file for more details. |
0 commit comments