3 Commits

Author SHA1 Message Date
PacNPal
af517b1283 Fixed details in README 2024-11-19 09:56:38 -05:00
PacNPal
e821ca9ec4 docs: add virtual environment and pipx installation notes
- Add recommendation to install within virtual environment
- Include pipx installation option for global use
- Improve installation section organization
2024-11-19 09:53:06 -05:00
PacNPal
854c784eab docs: add virtual environment and pipx installation notes
- Add recommendation to install within virtual environment
- Include pipx installation option for global use
- Improve installation section organization
2024-11-19 09:52:33 -05:00
2 changed files with 19 additions and 20 deletions

View File

@@ -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

View File

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
setup(
name="pip-add",
version="0.2.3",
version="0.2.5",
packages=find_packages(),
install_requires=[
"pip",