Skip to content

Installation

This guide explains how to install Aniwa for both end users and contributors.

Requirements

Aniwa currently requires:

  • Python 3.10+
  • pip
  • virtual environment support recommended

Verify your Python version:

python --version
````

---

# Install from PyPI

Install the latest release from PyPI:

```bash
pip install aniwa

Verify installation:

aniwa --help

Upgrade Aniwa:

pip install --upgrade aniwa

Install from Source

Clone the repository:

git clone https://github.com/ReginaldErzoah/Aniwa.git

Move into the project:

cd Aniwa

Create Virtual Environment

Windows

python -m venv .venv
source .venv/Scripts/activate

macOS/Linux

python3 -m venv .venv
source .venv/bin/activate

Install Dependencies

Install project dependencies:

pip install -r requirements.txt

Install Aniwa locally:

pip install -e .

Development Installation

Install development dependencies:

pip install pytest ruff build twine

Optional dependencies:

YAML Config Support

pip install pyyaml

TOML Support (Older Python Versions)

pip install tomli

Verify Installation

Run:

aniwa --help

You should see:

Aniwa - Universal dataset profiling and intelligence.

Test profiling:

aniwa examples/customers.csv

Supported Platforms

Aniwa currently supports:

  • Windows
  • macOS
  • Linux

Recommended Development Tools

Editors

Recommended editors:

  • VS Code
  • PyCharm
  • Neovim
  • Python
  • Ruff
  • Pylance
  • GitLens
  • Error Lens

Dependency Overview

Core dependencies include:

  • Typer
  • Rich
  • Polars
  • Pydantic
  • Jinja2
  • OpenPyXL
  • ReportLab

Packaging System

Aniwa uses:

  • setuptools
  • pyproject.toml
  • wheel

Build package:

python -m build

Publishing

Upload to PyPI:

twine upload dist/*

Common Installation Problems

Python Not Found

Install Python from:

https://python.org

Ensure Python is added to PATH.

Virtual Environment Activation Fails

On Windows PowerShell:

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

Missing Dependencies

Reinstall dependencies:

pip install -r requirements.txt

Recommended Setup Philosophy

Aniwa development should prioritize:

  • isolated environments
  • reproducible builds
  • pinned dependencies
  • automated testing
  • lightweight local workflows

Next Steps

Continue with:

  • quickstart.md
  • first-profile.md
  • configuration.md

```