Installation

Requirements

• Python 3.10 or newer (see requires-python in package metadata).

• httpx — declared as a dependency and installed automatically with clean-csv-python.

Important

Use a virtual environment in application projects so dependency versions stay isolated and reproducible.

Install from PyPI

python -m pip install clean-csv-python

Install for local development

From a clone of the repository (editable install, tests, and linters via [dev]):

python -m pip install -e ".[dev]"

Verify the install:

python -c "import cleancsv; print(cleancsv.__version__)"

Hosted documentation

Published HTML documentation is built on Read the Docs when the repository is connected. After you configure the project, add the documentation URL to your environment (see also Documentation in pyproject.toml project URLs).

Build documentation locally

Contributors can build the same docs as CI/Read the Docs:

python -m pip install -e ".[docs]"
python -m sphinx -W -b html docs docs/_build/html

Use python -m sphinx (not a random sphinx-build on PATH) so the active environment includes the Furo theme. Alternatively: .venv/bin/sphinx-build -W -b html docs docs/_build/html.

Open docs/_build/html/index.html in a browser. Configuration lives in docs/conf.py; automation uses .readthedocs.yaml.