Skip to main content

Generate PRISMA 2020 flow diagrams from Python.

Project description

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/, 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

pip install prisma-flowchart

Quickstart

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

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

Python Import

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

import prisma_flow_diagram

Included Template

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:

The exact setup steps are documented in docs/publishing.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prisma_flowchart-0.1.1.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

prisma_flowchart-0.1.1-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file prisma_flowchart-0.1.1.tar.gz.

File metadata

  • Download URL: prisma_flowchart-0.1.1.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for prisma_flowchart-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0f7b9994bc4099399176423ac8cfa91f3d4b15837ba52fe43769273bcf5c132b
MD5 6a2771a1ce2c05dcb2c45944ebf07743
BLAKE2b-256 fc4d5fea12a946407007e113e6ef57084e011aca3b0440e7170b18d1d069815b

See more details on using hashes here.

Provenance

The following attestation bundles were made for prisma_flowchart-0.1.1.tar.gz:

Publisher: publish-pypi.yml on aaekay/prisma-flowchart

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file prisma_flowchart-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for prisma_flowchart-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a98e471fe16b5c272a5206c28d124a0b477134b1eb0b268dc67a4c9f50b4abfe
MD5 1ab1e22109d1d0720fdc83ce570940f1
BLAKE2b-256 4d523b67c1785547bc1d68e2d3a37b0cb3cf13d362677e298d8a163bdc27c93c

See more details on using hashes here.

Provenance

The following attestation bundles were made for prisma_flowchart-0.1.1-py3-none-any.whl:

Publisher: publish-pypi.yml on aaekay/prisma-flowchart

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page