mirror of
https://github.com/pacnpal/pip-add.git
synced 2025-12-20 12:11:04 -05:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
af517b1283 | ||
|
|
e821ca9ec4 | ||
|
|
854c784eab | ||
|
|
5d6c25a50e | ||
|
|
1067ba9529 | ||
|
|
b6fe7168c9 |
37
README.md
37
README.md
@@ -20,7 +20,13 @@ Compatible with Python 3.11, 3.12, and 3.13.
|
||||
|
||||
## Installation
|
||||
|
||||
It's recommended to install pip-add within a virtual environment to avoid conflicts with system packages:
|
||||
|
||||
```bash
|
||||
# Create and activate virtual environment
|
||||
python -m venv venv
|
||||
source venv/bin/activate # or `venv\Scripts\activate` on Windows
|
||||
|
||||
# Install from PyPI
|
||||
pip install pip-add
|
||||
|
||||
@@ -28,9 +34,16 @@ pip install pip-add
|
||||
pip install --upgrade pip-add
|
||||
```
|
||||
|
||||
For global installation (use with caution), you can install with pipx:
|
||||
|
||||
```bash
|
||||
# Install globally using pipx
|
||||
pipx install pip-add
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Installation
|
||||
### Package Installation
|
||||
|
||||
```bash
|
||||
# Basic package installation
|
||||
@@ -120,7 +133,7 @@ pip-add -r -f requirements/dev.txt requests
|
||||
|
||||
## Command Line Options
|
||||
|
||||
```
|
||||
```bash
|
||||
pip-add [-h] [-d] [-e] [-r] [-f REQUIREMENTS_FILE] package
|
||||
|
||||
positional arguments:
|
||||
@@ -181,29 +194,15 @@ The tool is designed to safely handle dependencies:
|
||||
- pip
|
||||
- setuptools
|
||||
|
||||
## Development
|
||||
|
||||
### Local Setup
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/PacNPal/pip-add.git
|
||||
cd pip-add
|
||||
|
||||
# Create virtual environment
|
||||
python -m venv venv
|
||||
source venv/bin/activate # or `venv\Scripts\activate` on Windows
|
||||
|
||||
# Install in development mode
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
## Common Scenarios
|
||||
|
||||
### New Project
|
||||
|
||||
```bash
|
||||
# First time setup
|
||||
pip-add flask
|
||||
# Creates requirements.txt and adds Flask
|
||||
|
||||
pip-add -d flask
|
||||
# Creates requirements.txt and adds Flask with dependencies
|
||||
|
||||
|
||||
12
setup.py
12
setup.py
@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
|
||||
|
||||
setup(
|
||||
name="pip-add",
|
||||
version="0.2.1",
|
||||
version="0.2.5",
|
||||
packages=find_packages(),
|
||||
install_requires=[
|
||||
"pip",
|
||||
@@ -21,13 +21,23 @@ setup(
|
||||
url="https://github.com/PacNPal/pip-add",
|
||||
classifiers=[
|
||||
"Development Status :: 4 - Beta",
|
||||
"Environment :: Console",
|
||||
"Intended Audience :: Developers",
|
||||
"Intended Audience :: Information Technology",
|
||||
"Intended Audience :: System Administrators",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
"Natural Language :: English",
|
||||
"Operating System :: OS Independent",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Programming Language :: Python :: 3.13",
|
||||
"Programming Language :: Python :: Implementation :: CPython",
|
||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||
"Topic :: System :: Installation/Setup",
|
||||
"Topic :: System :: Software Distribution",
|
||||
"Topic :: System :: Systems Administration",
|
||||
"Topic :: Utilities",
|
||||
],
|
||||
python_requires=">=3.11",
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user