Metadata-Version: 2.4
Name: prisma-flowchart
Version: 0.1.1
Summary: Generate PRISMA 2020 flow diagrams from Python.
Home-page: https://github.com/prisma-flowdiagram/PRISMA2020
Author: PRISMA Flow Diagram Maintainers
License: MIT
Project-URL: Homepage, https://github.com/prisma-flowdiagram/PRISMA2020
Project-URL: Repository, https://github.com/prisma-flowdiagram/PRISMA2020
Project-URL: Issues, https://github.com/prisma-flowdiagram/PRISMA2020/issues
Project-URL: Documentation, https://github.com/prisma-flowdiagram/PRISMA2020
Keywords: prisma,systematic-review,flow-diagram,evidence-synthesis
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib>=3.7
Provides-Extra: dev
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# prisma-flowchart

`prisma-flowchart` is the PyPI distribution for the Python library that
generates PRISMA 2020 flow
diagrams from the existing PRISMA template CSV or from Python objects.

The current R implementation remains in [`PRISMA2020-main/`](
PRISMA2020-main/), and
this package reimplements the core public-library workflow in Python:

- load the PRISMA template CSV
- validate and normalize the data
- render an interactive HTML or SVG diagram
- export static PNG or PDF assets
- automate the same workflow from a CLI

## Install

```bash
pip install prisma-flowchart
```

## Quickstart

```python
from prisma_flow_diagram import load_prisma_csv, render_prisma

data = load_prisma_csv("PRISMA.csv")
diagram = render_prisma(data, interactive=True, previous=False, other=True)
diagram.save("prisma.html")
diagram.save("prisma.svg")
diagram.save("prisma.png")
```

## CLI

```bash
prisma-flow render PRISMA.csv prisma.html --interactive --no-previous
```

## Python Import

The distribution name is `prisma-flowchart`, but the import package remains:

```python
import prisma_flow_diagram
```

## Included Template

```python
from prisma_flow_diagram import get_template_csv_path

template_path = get_template_csv_path()
```

## Scope

Version `0.1.0` intentionally targets the core workflow:

- CSV ingestion compatible with the shipped PRISMA template
- programmatic construction through `FlowData`
- interactive HTML/SVG output with links and tooltips
- static SVG/PNG/PDF export

The following are intentionally deferred:

- Shiny-equivalent web UI
- ZIP, PS, or WEBP export parity
- deprecated R compatibility aliases
- every style knob exposed by the R package

## Release Automation

Trusted Publisher workflows are included for both TestPyPI and PyPI:

- [`.github/workflows/publish-testpypi.yml`](/Users/aaekay/Documents/projects/prisma_flow_diagram/.github/workflows/publish-testpypi.yml)
- [`.github/workflows/publish-pypi.yml`](/Users/aaekay/Documents/projects/prisma_flow_diagram/.github/workflows/publish-pypi.yml)

The exact setup steps are documented in
[`docs/publishing.md`](/Users/aaekay/Documents/projects/prisma_flow_diagram/docs/publishing.md).
