chore: improve installation instructions and package metadata for PyPI release
This commit is contained in:
9 files changed
+575
-13
No files matched your search
@@ -5,15 +5,12 @@ A collection of developer tools to enhance your workflow. This package includes
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
$ git clone https://github.com/S4NKALP/DevTools.git
|
||||
$ cd DevTools
|
||||
# Stable release from PyPI
|
||||
pip install devtools-utils
|
||||
|
||||
# Install in editable mode
|
||||
$ pipx install .
|
||||
# Using pipx
|
||||
pipx install devtools-utils
|
||||
|
||||
# Using Uv
|
||||
$ uv tool install .
|
||||
```
|
||||
|
||||
## Configuration
|
||||
@@ -453,14 +450,32 @@ python3 scripts/lintfix.py
|
||||
## Development
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
pip install -r requirements.txt
|
||||
# Clone the repository
|
||||
git clone https://github.com/S4NKALP/DevTools.git
|
||||
cd DevTools
|
||||
|
||||
# (Optional) Create and activate a virtual environment
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
|
||||
# Install package in editable (dev) mode
|
||||
pip install -e .
|
||||
|
||||
# Install dev tools (optional but recommended)
|
||||
pip install pytest black ruff
|
||||
|
||||
# Run tests
|
||||
pytest
|
||||
|
||||
# Lint
|
||||
# Lint and format
|
||||
black .
|
||||
|
||||
# Or use the helper scripts (if present)
|
||||
python3 scripts/format.py
|
||||
python3 scripts/lintfix.py
|
||||
|
||||
# Run the CLI locally after editable install
|
||||
devtools --help
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Reference in new issue
Block a user