Python Package Management
- Python Package Management
This article details best practices for managing Python packages on servers supporting a MediaWiki installation. Proper package management is crucial for maintaining a stable, secure, and reproducible environment. We will cover virtual environments, pip, and common pitfalls. This guide is geared toward system administrators and developers maintaining MediaWiki infrastructure.
Why Package Management Matters
Without proper package management, installing and updating Python dependencies can quickly become a nightmare. Conflicts between package versions, system-wide installations interfering with MediaWiki, and difficulty reproducing environments are common problems. Using virtual environments and a package manager like pip solves these issues. Software configuration is directly related to this topic.
Virtual Environments
Virtual environments create isolated Python environments. Each environment has its own set of installed packages, independent of the system-wide Python installation and other virtual environments. This prevents conflicts and ensures reproducibility.
Creating a Virtual Environment
Use the `venv` module (available in Python 3.3 and later) to create a virtual environment.
```bash python3 -m venv /path/to/your/environment ```
Replace `/path/to/your/environment` with the desired location for the environment.
Activating a Virtual Environment
Before installing packages, you must activate the virtual environment. The activation script is located in the environment's `bin` directory.
- **Bash/Zsh:**
```bash source /path/to/your/environment/bin/activate ```
- **Fish:**
```fish source /path/to/your/environment/bin/activate.fish ```
- **Csh/Tcsh:**
```csh source /path/to/your/environment/bin/activate.csh ```
Once activated, your shell prompt will typically be prefixed with the environment name.
Deactivating a Virtual Environment
To exit the virtual environment, simply type:
```bash deactivate ```
Pip: The Python Package Installer
Pip is the standard package installer for Python. It allows you to easily install, upgrade, and remove packages. It works best *within* an activated virtual environment. Python is the foundation of many MediaWiki extensions.
Installing Packages
To install a package, use the `pip install` command:
```bash pip install <package_name> ```
For example, to install the `requests` library:
```bash pip install requests ```
Specifying Package Versions
It's crucial to specify package versions to ensure reproducibility. Use the `==` operator to specify an exact version:
```bash pip install requests==2.28.1 ```
You can also use other comparison operators like `>` (greater than), `<` (less than), `>=` (greater than or equal to), and `<=` (less than or equal to).
Requirements Files
For complex projects with many dependencies, use a `requirements.txt` file. This file lists all the required packages and their versions.
Example `requirements.txt`:
``` requests==2.28.1 beautifulsoup4==4.11.1 ```
Install all packages from a requirements file using:
```bash pip install -r requirements.txt ```
Upgrading Packages
To upgrade a package to the latest version:
```bash pip install --upgrade <package_name> ```
To upgrade all packages listed in a requirements file:
```bash pip install --upgrade -r requirements.txt ```
Listing Installed Packages
To see a list of all installed packages and their versions:
```bash pip list ```
Or, for a more detailed output:
```bash pip freeze ```
The output of `pip freeze` is commonly used to generate a `requirements.txt` file.
Common Pitfalls and Best Practices
| Pitfall | Solution |
|---|---|
| Installing packages system-wide | Always use virtual environments. |
| Not specifying package versions | Use `requirements.txt` and pin specific versions. |
| Using `sudo pip install` | Avoid using `sudo` with `pip`. It can cause permission issues. Use virtual environments instead. |
| Ignoring dependency conflicts | Carefully review error messages and resolve conflicts by specifying versions. |
Package Caching
Pip caches downloaded packages to speed up subsequent installations. The cache location varies depending on your operating system. You can clear the cache using:
```bash pip cache purge ```
Managing Multiple Environments
Consider using tools like `virtualenvwrapper` or `conda` to manage multiple virtual environments more effectively. System administration benefits from these tools.
Security Considerations
Always verify the source of the packages you install. Use reputable package indexes like the Python Package Index (PyPI). Be cautious of typosquatting attacks, where malicious packages are uploaded with names similar to legitimate packages. Consider using a vulnerability scanner to identify security issues in your dependencies. Security is paramount.
Example Server Configuration Table
| Component | Setting | Value |
|---|---|---|
| Python Version | Supported Versions | 3.8, 3.9, 3.10 |
| Virtual Environment Location | Default Location | /opt/mediawiki/venv |
| Package Manager | Preferred Tool | pip |
| Requirements File | Location | /opt/mediawiki/requirements.txt |
Troubleshooting
| Problem | Possible Solution |
|---|---|
| `ImportError: No module named <module>` | Ensure the virtual environment is activated and the package is installed within it. |
| `pip install` fails with permission errors | Do not use `sudo pip install`. Use a virtual environment. |
| Dependency conflicts | Specify specific package versions in `requirements.txt`. |
| Slow installation times | Check your internet connection and consider using a package mirror. |
Further Resources
- [Python Virtual Environments Documentation](https://docs.python.org/3/tutorial/venv.html)
- [Pip Documentation](https://pip.pypa.io/en/stable/)
- [Requirements Files Documentation](https://pip.pypa.io/en/stable/reference/requirements-file-format/)
- Extension development often requires careful package management
- MediaWiki architecture depends on the correct functioning of Python packages.
- Debugging often involves inspecting package versions.
- Performance optimization can be affected by package choices.
Intel-Based Server Configurations
| Configuration | Specifications | Benchmark |
|---|---|---|
| Core i7-6700K/7700 Server | 64 GB DDR4, NVMe SSD 2 x 512 GB | CPU Benchmark: 8046 |
| Core i7-8700 Server | 64 GB DDR4, NVMe SSD 2x1 TB | CPU Benchmark: 13124 |
| Core i9-9900K Server | 128 GB DDR4, NVMe SSD 2 x 1 TB | CPU Benchmark: 49969 |
| Core i9-13900 Server (64GB) | 64 GB RAM, 2x2 TB NVMe SSD | |
| Core i9-13900 Server (128GB) | 128 GB RAM, 2x2 TB NVMe SSD | |
| Core i5-13500 Server (64GB) | 64 GB RAM, 2x500 GB NVMe SSD | |
| Core i5-13500 Server (128GB) | 128 GB RAM, 2x500 GB NVMe SSD | |
| Core i5-13500 Workstation | 64 GB DDR5 RAM, 2 NVMe SSD, NVIDIA RTX 4000 |
AMD-Based Server Configurations
| Configuration | Specifications | Benchmark |
|---|---|---|
| Ryzen 5 3600 Server | 64 GB RAM, 2x480 GB NVMe | CPU Benchmark: 17849 |
| Ryzen 7 7700 Server | 64 GB DDR5 RAM, 2x1 TB NVMe | CPU Benchmark: 35224 |
| Ryzen 9 5950X Server | 128 GB RAM, 2x4 TB NVMe | CPU Benchmark: 46045 |
| Ryzen 9 7950X Server | 128 GB DDR5 ECC, 2x2 TB NVMe | CPU Benchmark: 63561 |
| EPYC 7502P Server (128GB/1TB) | 128 GB RAM, 1 TB NVMe | CPU Benchmark: 48021 |
| EPYC 7502P Server (128GB/2TB) | 128 GB RAM, 2 TB NVMe | CPU Benchmark: 48021 |
| EPYC 7502P Server (128GB/4TB) | 128 GB RAM, 2x2 TB NVMe | CPU Benchmark: 48021 |
| EPYC 7502P Server (256GB/1TB) | 256 GB RAM, 1 TB NVMe | CPU Benchmark: 48021 |
| EPYC 7502P Server (256GB/4TB) | 256 GB RAM, 2x2 TB NVMe | CPU Benchmark: 48021 |
| EPYC 9454P Server | 256 GB RAM, 2x2 TB NVMe |
Order Your Dedicated Server
Configure and order your ideal server configuration
Need Assistance?
- Telegram: @powervps Servers at a discounted price
⚠️ *Note: All benchmark scores are approximate and may vary based on configuration. Server availability subject to stock.* ⚠️