Welcome to standard-deluxe’s documentation!¶
Standard-Deluxe is an open-Source general-purpose Python library.
Overview¶
Standard-Deluxe provides a handpicked collection of enhanced Python modules
that extend the standard library with robust, type-safe, and pythonic solutions.
Standard-Deluxe is positioned as a general Python library tailored for application
development.
The name Standard-Deluxe draws inspiration from the argentic photography era’s Agfa Standard Deluxe cameras known for their high quality and craftsmanship.
Getting Started¶
Requirements¶
Python 3.11 or higher
No external dependencies required
Installation¶
Add library to your pyproject.toml dependencies:
[project]
dependencies = [ "standard-deluxe" ]
Using uv to add library to your pyproject.toml:
uv add standard-deluxe
Or to install in a dedicated virtual environment.
uv pip install standard-deluxe
Alternatively, you can install it with pip:
pip install standard-deluxe
Usage¶
Standard-Deluxe modules are designed to integrate seamlessly with your existing
Python workflows, providing enhanced functionality. The python library name is
just deluxe:
from deluxe.types import Unset
my_var: str = Unset
Type Safety First: Type safety is a foundational concern. Constant effort is dedicated to make accurate and meaningful type annotations that work seamlessly with static type checkers like pyright/basedpyright, or mypy.
Comprehensive Documentation: Every API is documented with well-formatted
docstrings used to generate API HTML documentation and offer useful hints
inside IDE or with python help() function call.
Zero Dependencies: Built with no external dependencies as pure Python or c based extension module where performance is a concern.
Pythonic: Adherence to Python best practices with careful avoidance of anti-patterns, following the principle that code should be both elegant and practical.
PEP 8 Compliance: All APIs follow Python naming conventions and style guidelines for consistent, readable code.