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 username and password for the PyPi server
  • An AIminify password for using the code

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 password using one of the following commands based on your package manager:
# Pip, pip-tools and Pipx
aiminify configure PASSWORD
 
# Conda
conda run -n your_env_name aiminify configure PASSWORD
 
# Poetry
poetry run aiminify configure PASSWORD
 
# Pipenv
pipenv run aiminify configure PASSWORD

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 <<< "from aiminify import minify"
 
# Conda
conda run -n your_env_name python -c "from aiminify import minify"
 
# Poetry
poetry run python -c "from aiminify import minify"
 
# Pipenv
pipenv run python -c "from aiminify import minify"
Now you have installed, configured and verified that AIminify is working in your environment. Now head over to  the usage manual  to continue!