Documentation
Learn how to use PyPM effectively with comprehensive guides, examples, and API reference.
Installation
Quick Install
curl -sSL https://pypm.io/install | python3
One-liner installation for most systems
Windows
powershell -c "irm https://pypm.io/install.ps1 | iex"
PowerShell installation for Windows
macOS
brew install pypm
Install via Homebrew
Linux
sudo apt install pypm
Package manager installation
Verify Installation
pypm --version
You should see the PyPM version number if installation was successful.
Quick Start Guide
Create a New Project
pypm init my-project
This creates a new directory with a basic project structure and configuration files.
Add Dependencies
pypm add requests flask
Add packages to your project. PyPM will automatically resolve dependencies and update the lock file.
Install Dependencies
pypm install
Install all dependencies listed in your project configuration.
Run Your Project
pypm run dev
Execute your project with the defined scripts.
Command Reference
Project Management
pypm init [name]
Initialize a new project
pypm install
Install all dependencies
pypm add <package>
Add a package to dependencies
pypm remove <package>
Remove a package from dependencies
Development
pypm run <script>
Run a defined script
pypm shell
Activate virtual environment
pypm test
Run tests
pypm build
Build the project
Package Management
pypm search <query>
Search for packages
pypm show <package>
Show package details
pypm update
Update all packages
pypm audit
Security audit
Configuration
pypm config
Show configuration
pypm config set <key> <value>
Set configuration value
pypm cache clear
Clear cache
pypm --help
Show help
Configuration
Project Configuration (pypm.toml)
[project]
name = "my-project"
version = "0.1.0"
description = "A sample project"
authors = ["Your Name <your.email@example.com>"]
readme = "README.md"
requires-python = ">=3.8"
[tool.pypm.dependencies]
requests = "^2.31.0"
flask = "^3.0.0"
[tool.pypm.dev-dependencies]
pytest = "^7.4.0"
black = "^23.0.0"
[tool.pypm.scripts]
dev = "python -m flask run"
test = "pytest"
build = "python setup.py build"Examples
Web Application
# Initialize project
pypm init webapp
# Add dependencies
pypm add flask sqlalchemy
# Create virtual environment
pypm shell
# Run development server
pypm run devData Science Project
# Initialize project
pypm init datascience
# Add data science packages
pypm add pandas numpy matplotlib
# Add development tools
pypm add --dev jupyter pytest
# Install and run Jupyter
pypm install
pypm run jupyterPackage Development
# Initialize package
pypm init my-package
# Add dependencies
pypm add click
# Add development dependencies
pypm add --dev pytest black
# Run tests
pypm test
# Build package
pypm buildTroubleshooting
Installation Issues
Permission Denied
Error: Permission denied when installing
Solution: Use sudo or install for user only with --user flag
Python Version
Error: Python version not supported
Solution: Ensure Python 3.8+ is installed and in PATH
Dependency Issues
Conflicts
Error: Dependency conflicts
Solution: Use pypm resolve to see conflicts and resolve manually
Network Issues
Error: Connection timeout
Solution: Check network connection and try different mirrors
Performance Issues
Slow Installation
Issue: Installation is slow
Solution: Clear cache with pypm cache clear and try again
Memory Usage
Issue: High memory usage
Solution: Use --no-cache flag for one-time installations
Frequently Asked Questions
How does PyPM differ from pip?
PyPM is significantly faster, has built-in security scanning, better dependency resolution, and lock files for reproducible builds.
Can I use PyPM with existing projects?
Yes! You can convert existing projects by running pypm init in your project directory and PyPM will detect existing dependencies.
Is PyPM compatible with pip packages?
Absolutely! PyPM can install any package available on PyPI and is fully compatible with the Python packaging ecosystem.
How do I migrate from pip/poetry?
Run pypm init in your project directory, then pypm install to install all dependencies. PyPM will automatically detect requirements.txt or pyproject.toml files.