Getting Started

Prerequisites

You need:

• Python 3.12+
• a Python project with importable source files

Installation

uv tool install privata

pipx install privata

pip install privata

git clone https://github.com/basnijholt/privata.git
cd privata
uv sync --extra dev

Run

From a project root:

privata .

Privata exits with status 0 when no privacy issues are found. It exits with status 1 when it finds public symbols that can be made private or private module imports that cross package boundaries.

Pre-Commit

Add Privata to another repository's .pre-commit-config.yaml:

repos:
  - repo: https://github.com/basnijholt/privata
    rev: v0.1.2
    hooks:
      - id: privata

Use id: privata-manual instead if you only want to run Privata on demand:

pre-commit run --hook-stage manual privata-manual --all-files

Source Roots

Privata uses tach.toml source_roots when present:

source_roots = ["lib"]

Without Tach source roots, Privata prefers a src/ directory:

project/
├── pyproject.toml
└── src/
    └── package/
        ├── __init__.py
        └── module.py

If src/ is absent, Privata scans the project root and ignores tests, virtualenvs, build output, docs output, and hidden tooling directories. Tests can live anywhere. Imports from tests do not count when deciding whether a symbol should stay public.