feu 🔥

Overview

feu (French word for "fire" 🔥) is a lightweight Python library designed to help manage Python packages and their versions across different Python environments.

Key Features

• ✅ Check package availability: Verify if packages and modules are installed
• 🔄 Version-aware installation: Install packages with automatic version compatibility checks
• 🎯 Smart version resolution: Find the closest valid package version for your target environment (Python version, free-threadedness, OS, and CPU architecture)
• 📋 Package registry: Built-in compatibility information for popular packages (numpy, pandas, polars, torch, etc.)
• 🔍 PyPI-backed discovery: Automatically discover version compatibility from PyPI for packages that aren't in the built-in registry
• 🐙 GitHub utilities: Fetch and sort repository metadata from the GitHub API
• 🖥️ CLI tools: Command-line interface for package management tasks
• 🪶 Lightweight: Minimal dependencies (only packaging required for core functionality)

Quick Example

from feu.imports import is_package_available
from feu.compat import Target, find_closest_version
from feu.version import get_package_version

# Check if a package is available
if is_package_available("numpy"):
    version = get_package_version("numpy")
    print(f"NumPy {version} is installed!")

# Find the closest valid version for your Python version
version = find_closest_version(
    pkg_name="numpy", pkg_version="2.0.2", target=Target(python_version="3.10")
)
print(f"Closest valid version: {version}")

Why feu?

Managing Python package versions across different Python versions can be challenging. Different Python versions support different package versions, and manually tracking compatibility can be error-prone. feu solves this by:

1. Automating version selection: Automatically finds compatible package versions for your Python environment
2. Preventing installation failures: Validates versions before installation to avoid runtime errors
3. Simplifying multi-version support: Makes it easy to support multiple Python versions in your projects
4. Providing graceful fallbacks: Check package availability and provide alternatives when packages aren't installed

Documentation

• 📚 Full Documentation
• 🚀 Get Started Guide
• 📖 Usage Examples
• 🖥️ CLI Reference

Quick Links

• Installation
• Contributing
• API stability
• License

Installation

We highly recommend installing a virtual environment. feu can be installed from pip using the following command:

pip install feu

To make the package as slim as possible, only the minimal packages required to use feu are installed. To include all the dependencies, you can use the following command:

pip install feu[all]

Please check the get started page to see how to install only some specific dependencies or other alternatives to install the library. The following is the corresponding feu versions and supported dependencies.

^* indicates an optional dependency

Contributing

Please check the instructions in CONTRIBUTING.md.

Suggestions and Communication

Everyone is welcome to contribute to the community. If you have any questions or suggestions, you can submit Github Issues. We will reply to you as soon as possible. Thank you very much.

API stability

⚠️ While feu is in development stage, no API is guaranteed to be stable from one release to the next. In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release. In practice, this means that upgrading feu to a new version will possibly break any code that was using the old version of feu.

License

feu is licensed under BSD 3-Clause "New" or "Revised" license available in LICENSE file.