Skip to content

Commit d325d65

Browse files
committed
updated readme docs
1 parent 45107e4 commit d325d65

File tree

1 file changed

+40
-33
lines changed

1 file changed

+40
-33
lines changed

README.md

Lines changed: 40 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,67 @@
1-
# Setups Python
1+
<p align="center">
2+
# Setups Python
3+
</p>
4+
<p align="center">
5+
<img src="https://img.shields.io/pypi/v/setups.svg" alt="PyPI Version">
6+
<img src="https://img.shields.io/github/license/muhammad-fiaz/setups-python.svg" alt="License Badge">
7+
<img src="https://img.shields.io/pypi/pyversions/setups.svg" alt="Python Version">
8+
<img src="https://img.shields.io/pypi/dm/setups.svg" alt="Downloads">
9+
<img src="https://img.shields.io/github/issues-pr/muhammad-fiaz/setups-python.svg" alt="PRs">
10+
<img src="https://img.shields.io/github/issues/muhammad-fiaz/setups-python.svg" alt="Issues">
11+
<img src="https://img.shields.io/github/contributors/muhammad-fiaz/setups-python.svg" alt="Contributors">
12+
<img src="https://img.shields.io/github/last-commit/muhammad-fiaz/setups-python" alt="Last Commit">
13+
<img src="https://img.shields.io/github/commit-activity/m/muhammad-fiaz/setups-python.svg" alt="Commit Activity">
14+
<img src="https://img.shields.io/github/license/muhammad-fiaz/setups-python.svg" alt="License Badge">
15+
</p>
216

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.
17+
**Setups Python** is a Python CLI tool to generate a `setup.py` file for your Python project dynamically. It prompts the user for key project details like dependencies, license types, and classifiers.
418

519
## Features
620

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.
21+
- Generate a `setup.py` with interactive prompts
22+
- Supports common open-source licenses
23+
- Define project metadata including dependencies, version, and URLs
24+
- Integrate with PyPI and other tools seamlessly
1125

1226
## Installation
1327

14-
You can install `setups` from PyPI using pip:
15-
1628
```bash
1729
pip install setups
1830
```
1931

2032
## Usage
2133

22-
To generate a `setup.py` for your project, use the following command:
34+
To create a `setup.py` file for your new project:
2335

2436
```bash
2537
setup new <project_name>
2638
```
2739

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-
3940
## Example
4041

4142
```bash
4243
$ setup new my-awesome-project
4344
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
45+
Short project description: An awesome project
46+
License type: MIT
47+
Minimum Python version required: 3.8
48+
Dependencies: numpy, requests
5649
```
5750

51+
## Contributing
52+
53+
We welcome contributions! Fork the repository, create a feature branch, and submit a pull request. Please follow the steps below:
54+
55+
1. Fork the repository
56+
2. Create a new branch: `git checkout -b feature-name`
57+
3. Commit your changes: `git commit -am 'Add feature'`
58+
4. Push to your fork: `git push origin feature-name`
59+
5. Submit a pull request
60+
61+
## Code of Conduct
62+
63+
By participating in this project, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
64+
5865
## License
5966

60-
MIT License. See the [LICENSE](LICENSE) file for more details.
67+
MIT License. See the [LICENSE](LICENSE) file for more details.

0 commit comments

Comments
 (0)