mirror of
https://github.com/pacnpal/pip-add.git
synced 2025-12-20 12:11:04 -05:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
af517b1283 | ||
|
|
e821ca9ec4 | ||
|
|
854c784eab |
37
README.md
37
README.md
@@ -20,7 +20,13 @@ Compatible with Python 3.11, 3.12, and 3.13.
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
It's recommended to install pip-add within a virtual environment to avoid conflicts with system packages:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Create and activate virtual environment
|
||||||
|
python -m venv venv
|
||||||
|
source venv/bin/activate # or `venv\Scripts\activate` on Windows
|
||||||
|
|
||||||
# Install from PyPI
|
# Install from PyPI
|
||||||
pip install pip-add
|
pip install pip-add
|
||||||
|
|
||||||
@@ -28,9 +34,16 @@ pip install pip-add
|
|||||||
pip install --upgrade 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
|
## Usage
|
||||||
|
|
||||||
### Installation
|
### Package Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Basic package installation
|
# Basic package installation
|
||||||
@@ -120,7 +133,7 @@ pip-add -r -f requirements/dev.txt requests
|
|||||||
|
|
||||||
## Command Line Options
|
## Command Line Options
|
||||||
|
|
||||||
```
|
```bash
|
||||||
pip-add [-h] [-d] [-e] [-r] [-f REQUIREMENTS_FILE] package
|
pip-add [-h] [-d] [-e] [-r] [-f REQUIREMENTS_FILE] package
|
||||||
|
|
||||||
positional arguments:
|
positional arguments:
|
||||||
@@ -181,29 +194,15 @@ The tool is designed to safely handle dependencies:
|
|||||||
- pip
|
- pip
|
||||||
- setuptools
|
- 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
|
## Common Scenarios
|
||||||
|
|
||||||
### New Project
|
### New Project
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# First time setup
|
# First time setup
|
||||||
|
pip-add flask
|
||||||
|
# Creates requirements.txt and adds Flask
|
||||||
|
|
||||||
pip-add -d flask
|
pip-add -d flask
|
||||||
# Creates requirements.txt and adds Flask with dependencies
|
# Creates requirements.txt and adds Flask with dependencies
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user