Metadata-Version: 2.4
Name: ftm-random
Version: 0.4.0
Summary: Add your description here
License: MIT
License-File: LICENSE
Requires-Python: >=3.13
Requires-Dist: click>=8.3.1
Requires-Dist: faker>=40.5.1
Requires-Dist: followthemoney>=4.0.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.9; extra == 'dev'
Description-Content-Type: text/markdown

# ftm-random

Generate random [followthemoney](https://followthemoney.tech) entities.

# Usage

Run it with `uvx` (requires [uv](https://docs.astral.sh/uv/)).

```
$ uvx ftm-random
```

or install it with pip:

```
$ pip install ftm-random
```

<!-- help-start -->
```
$ ftm-random --help
Usage: ftm-random [OPTIONS]

  Generate random followthemoney entities.

Options:
  --count INTEGER  Number of entities to generate.
  --schema TEXT    FTM schema name (can be specified multiple times).
  --random-schema  Use a random schema for each entity.
  --connected      Link edge entities (e.g. Directorship) to other generated
                   entities.
  --outfile TEXT   JSONL output file (leave this out for STDOUT)
  --list           List all available FTM schemas with their type and
                   description.
  --help           Show this message and exit.
```
<!-- help-end -->

# Development

This project uses [uv](https://docs.astral.sh/uv) and [prek](https://prek.j178.dev/).

Run tests with:

```
$ uv run pytest
```

or run tests and linters with:

```
$ prek run
```
