Installation

Install AlexBerUtils via pip, GitHub, or Docker with optional dependency groups.

Requirements

• Python 3.8+
• PyYAML >= 6.0.1 (installed automatically)
• packaging >= 23.2 (installed automatically)

Install from PyPI

The quickest way to install AlexBerUtils:

python -m pip install -U alex-ber-utils

This installs the core package with its required dependencies (PyYAML and packaging).

Optional dependency groups

AlexBerUtils uses optional extras for features that require additional third-party packages. Install only what you need:

[yml]

Enables YAML-related features used in ymlparsers.py, init_app_conf.py, and deploys.py.

python -m pip install alex-ber-utils[yml]

Installs hiyapyco and jinja2.

[env]

Enables .env file loading used in deploys.py and mains.py.

python -m pip install alex-ber-utils[env]

Installs python-dotenv.

[tests]

Installs test dependencies for running the test suite.

python -m pip install alex-ber-utils[tests]

[fabric]

Installs Fabric, used in fabs.py for deployment automation.

python -m pip install alex-ber-utils[fabric]

[piptools]

Installs pip-tools for dependency management.

python -m pip install alex-ber-utils[piptools]

Install from GitHub

To install the latest development version directly from GitHub:

1. Install from the master branch archive

   python -m pip install -U https://github.com/alex-ber/AlexBerUtils/archive/master.zip
   
2. Include optional extras (optional)

   Append an extras specifier to install optional dependencies at the same time:

   python -m pip install -U "https://github.com/alex-ber/AlexBerUtils/archive/master.zip#egg=alex-ber-utils[tests]"
   
3. Or download and install from source

   wget https://github.com/alex-ber/AlexBerUtils/archive/master.zip -O master.zip
   unzip master.zip
   rm master.zip
   python -m pip install .
   

Install from source

After cloning the repository, install from the directory that contains setup.py:

Core only

python -m pip install .

Install from requirements files

You can also pin exact versions using the provided requirements files:

python -m pip install -r requirements.txt          # core only
python -m pip install -r requirements-tests.txt    # test dependencies
python -m pip install -r requirements-yml.txt      # YAML dependencies
python -m pip install -r requirements-env.txt      # env dependencies
python -m pip install -r requirements-fabric.txt   # Fabric
python -m pip install -r requirements-piptools.txt # pip-tools

Docker

The alexberkovich/alex_ber_utils:latest image includes all AlexBerUtils dependencies. You can use it as a base image for your project:

FROM alexberkovich/alex_ber_utils:latest

COPY requirements.txt etc/requirements.txt

RUN set -ex && \
    pip install --upgrade pip setuptools wheel && \
    pip install alex_ber_utils && \
    pip install -r etc/requirements.txt

CMD ["/bin/sh"]

Replace requirements.txt with your project’s own requirements file.

The Docker image is a convenient starting point. You can extend it by adding or upgrading dependencies as needed for your specific application.

Verify installation

Confirm the package installed correctly:

import alexber.utils
print("AlexBerUtils installed successfully")

If you plan to use YAML-based configuration (init_app_conf, ymlparsers), install the [yml] extra. Most other features work with the core install.