Skip to content

Commit

Permalink
updated readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
muhammad-fiaz committed Nov 19, 2024
1 parent e0c34ea commit 45107e4
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 4 deletions.
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Setups Python

**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.

## Features

- Automatically generate a `setup.py` file for your Python project.
- Configure project version, description, license, dependencies, and more.
- Choose from a wide range of open-source licenses.
- Customize the setup process with URLs, classifiers, and other metadata.

## Installation

You can install `setups` from PyPI using pip:

```bash
pip install setups
```

## Usage

To generate a `setup.py` for your project, use the following command:

```bash
setup new <project_name>
```

You'll be prompted for the following information:

- Project version
- Short and long descriptions
- Author name and email
- License type (MIT, GPL, etc.)
- Minimum Python version required
- List of dependencies and test dependencies
- Project URL, bug tracker URL, and documentation URL
- Classifiers for the project

## Example

```bash
$ setup new my-awesome-project
Version (e.g., 0.1.0): 0.1.0
Short project description: A cool project
Long description (use content from your README.md): This project is amazing.
Author name: John Doe
Author email: johndoe@example.com
License type (MIT, GPL-3.0, etc.): MIT
Minimum Python version required (e.g., 3.8): 3.8
Comma-separated list of dependencies (leave empty for none): numpy, requests
Comma-separated list of test dependencies (leave empty for none): pytest
Project URL (e.g., GitHub URL): https://github.com/johndoe/my-awesome-project
Bug tracker URL: https://github.com/johndoe/my-awesome-project/issues
Documentation URL: https://github.com/johndoe/my-awesome-project/wiki
Comma-separated list of classifiers: Development Status :: 5 - Production/Stable, Intended Audience :: Developers
```

## License

MIT License. See the [LICENSE](LICENSE) file for more details.
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
description=DESCRIPTION, # Short description
long_description=LONG_DESCRIPTION, # Detailed description from README.md
long_description_content_type="text/markdown", # Format of the long description
url="https://github.com/muhammad-fiaz/setups", # URL to the project's GitHub page
url="https://github.com/muhammad-fiaz/setups-python", # URL to the project's GitHub page
packages=find_packages(), # Automatically find all packages in the directory
classifiers=[ # List of classifiers to categorize your package
"Development Status :: 3 - Alpha",
Expand All @@ -35,9 +35,9 @@
tests_require=['pytest'], # Dependencies for running tests
license='MIT', # License for the project
project_urls={ # Additional URLs related to your project
'Source Code': 'https://github.com/muhammad-fiaz/setups',
'Bug Tracker': 'https://github.com/muhammad-fiaz/setups/issues',
'Documentation': 'https://github.com/muhammad-fiaz/setups#readme',
'Source Code': 'https://github.com/muhammad-fiaz/setups-python',
'Bug Tracker': 'https://github.com/muhammad-fiaz/setups-python/issues',
'Documentation': 'https://github.com/muhammad-fiaz/setups-python#readme',
},
entry_points={ # CLI Entry Point
'console_scripts': [
Expand Down

0 comments on commit 45107e4

Please sign in to comment.