Installation Guide
Apathetic Python Utils can be installed using several methods. Choose the one that best fits your project’s needs.
Primary Method: PyPI (Recommended)
The recommended way to install Apathetic Python Utils is via PyPI. We prefer poetry over pip for its pyproject.toml support, automatic venv management, and tool configuration without dotfiles.
Using Poetry (Preferred)
poetry add apathetic-utils
Using pip
pip install apathetic-utils
This installation method provides:
- Easy dependency management
- Version pinning
- Integration with your existing Python project structure
Alternative: Single-File Distribution
For projects that prefer a single-file dependency, we also distribute a stitched apathetic_utils.py file that you can download directly from releases.
Download and Use
- Download
apathetic_utils.pyfrom the latest release - Place it in your project directory
- Import it directly:
import apathetic_utils
This method is useful for:
- Projects that want to integrate dependencies directly into their codebase
(avoiding package managers and external dependencies) - Embedded systems or restricted environments
(including offline/air-gapped deployments)
Requirements
- Python 3.10+
Apathetic Python Utils has zero runtime dependencies — it uses only Python’s standard library. This makes it perfect for CLI tools and applications where dependency bloat is a concern.
Verification
After installation, verify that it works:
from apathetic_utils import is_ci, load_jsonc
from pathlib import Path
# Test CI detection
print(f"Running in CI: {is_ci()}")
# Test file loading (if you have a test file)
# config = load_jsonc(Path("test.jsonc"))
If the import succeeds, installation was successful!
Next Steps
- Read the Quick Start Guide to get up and running
- Check out the API Reference for detailed documentation
- See Examples for advanced usage patterns