4 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
PacNPal
5d6c25a50e fix: remove invalid classifier and bump version to 0.2.3 2024-11-19 09:45:18 -05:00
2 changed files with 20 additions and 21 deletions

View File

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

View File

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
setup( setup(
name="pip-add", name="pip-add",
version="0.2.2", version="0.2.5",
packages=find_packages(), packages=find_packages(),
install_requires=[ install_requires=[
"pip", "pip",
@@ -23,6 +23,7 @@ setup(
"Development Status :: 4 - Beta", "Development Status :: 4 - Beta",
"Environment :: Console", "Environment :: Console",
"Intended Audience :: Developers", "Intended Audience :: Developers",
"Intended Audience :: Information Technology",
"Intended Audience :: System Administrators", "Intended Audience :: System Administrators",
"License :: OSI Approved :: MIT License", "License :: OSI Approved :: MIT License",
"Natural Language :: English", "Natural Language :: English",
@@ -37,7 +38,6 @@ setup(
"Topic :: System :: Software Distribution", "Topic :: System :: Software Distribution",
"Topic :: System :: Systems Administration", "Topic :: System :: Systems Administration",
"Topic :: Utilities", "Topic :: Utilities",
"Framework :: pip",
], ],
python_requires=">=3.11", python_requires=">=3.11",
) )