Installation

This guide provides detailed steps to install and configure the AIMinify package, a Python library available via the AIMinify PyPi server.

Prerequisites

Before proceeding with the installation, ensure you have the following:
  • Python installed on your system
  • An AIMinify License file
  • An AIMinify username and password for the PyPi server
  • The  cryptography  package installed in your Python environment. This can be installed using the following command:
pip install cryptography

Installation instructions

# Pip
pip install aiminify -i https://USERNAME:PASSWORD@pypi.aiminify.com/
 
# Conda
conda run -n your_env_name pip install aiminify -i https://USERNAME:PASSWORD@pypi.aiminify.com/
 
# Pipx
pipx install aiminify --pip-args="--index-url https://USERNAME:PASSWORD@pypi.aiminify.com/"
 
# Poetry
poetry add aiminify --repository https://USERNAME:PASSWORD@pypi.aiminify.com/
 
# Pipenv
PIPENV_EXTRA_INDEX_URL=https://USERNAME:PASSWORD@pypi.aiminify.com/ pipenv install aiminify --skip-lock
After the installation process is complete, AIMinify should be successfully installed in your Python environment.

Configuration

Before using AIMinify, configure the library with your license file using one of the following commands based on your package manager:
# Pip, pip-tools and Pipx
aiminify configure /path/to/license-file.license
 
# Conda
conda run -n your_env_name aiminify configure /path/to/license-file.license
 
# Poetry
poetry run aiminify configure /path/to/license-file.license
 
# Pipenv
pipenv run aiminify configure /path/to/license-file.license

Validation

To verify that AIMinify is correctly installed and configured, attempt to import the library using the appropriate command for your environment:
# Pip, pip-tools and Pipx
python <<< "import aiminify.minify"
 
# Conda
conda run -n your_env_name python -c "import aiminify.minify"
 
# Poetry
poetry run python -c "import aiminify.minify"
 
# Pipenv
pipenv run python -c "import aiminify.minify"
Now you have installed, configured and verified that AIMinify is working in your environment. Now head over to the usage manual to continue!