Skip to content

Installation

Requirements

  • Python 3.9 or higher
  • pip (Python package manager)

Quick Install

The simplest way to install Schopenhauer is via pip:

pip install schopenhauer

This installs the core package with all essential dependencies for document generation.

Installation Options

Core Installation

Basic installation with document generation capabilities:

pip install schopenhauer

Includes:

  • python-docx - Word document manipulation
  • click - CLI framework
  • rich - Beautiful terminal output
  • pyyaml - YAML parsing
  • pillow - Image handling
  • httpx - HTTP client
  • jinja2 - Template engine

With API Server

Install with FastAPI server support for cloud deployment:

pip install schopenhauer[api]

Additional packages:

  • fastapi - Web framework
  • uvicorn - ASGI server
  • python-multipart - File upload handling

With Documentation Tools

Install with documentation generation tools:

pip install schopenhauer[docs]

Additional packages:

  • mkdocs - Documentation generator
  • mkdocs-material - Material theme
  • mkdocstrings - API documentation

Development Installation

Install with all development dependencies:

pip install schopenhauer[dev]

Additional packages:

  • pytest - Testing framework
  • pytest-cov - Coverage reporting
  • black - Code formatter
  • ruff - Linter
  • mypy - Type checking
  • pre-commit - Git hooks

Full Installation

Install everything:

pip install schopenhauer[all]

Verify Installation

After installation, verify that the will command is available:

will --version

Expected output:

Schopenhauer's Will version 0.1.0
Primary color: Burgundy

Installing from Source

For the latest development version:

# Clone the repository
git clone https://github.com/schopenhauer/schopenhauer.git
cd schopenhauer

# Install in development mode
pip install -e ".[dev]"

We recommend using a virtual environment to avoid conflicts with other packages:

# Create virtual environment
python -m venv .venv

# Activate (Linux/macOS)
source .venv/bin/activate

# Activate (Windows)
.venv\Scripts\activate

# Install
pip install schopenhauer

# Create conda environment
conda create -n schopenhauer python=3.11

# Activate
conda activate schopenhauer

# Install
pip install schopenhauer

# Create and install with uv
uv venv
source .venv/bin/activate  # or .venv\Scripts\activate on Windows
uv pip install schopenhauer

Upgrading

To upgrade to the latest version:

pip install --upgrade schopenhauer

Uninstalling

To remove Schopenhauer:

pip uninstall schopenhauer

Troubleshooting

Command not found

If will is not found after installation, ensure your Python scripts directory is in your PATH:

# Find where pip installs scripts
python -m site --user-base

Add the bin (Linux/macOS) or Scripts (Windows) subdirectory to your PATH.

Import errors

If you encounter import errors, try reinstalling with all dependencies:

pip uninstall schopenhauer
pip install schopenhauer --no-cache-dir

Permission errors

On Linux/macOS, if you get permission errors:

pip install --user schopenhauer

Or use a virtual environment (recommended).

Next Steps