Seedcase Flower logo.

Seedcase Flower font.

Turn your Data Package metadata into human-readable documentation

Overview Explore guide

Copier Python Version from PEP 621 TOML GitHub License GitHub Release Build documentation Check package OpenSSF Scorecard CodeQL code coverage pre-commit.ci status lifecycle Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

Flower is a Python package and command-line interface (CLI) that generates human-readable documentation from your Data Package metadata.

✨ Key features

  • Create structured and human-friendly documents from a Data Package’s datapackage.json file.
  • Display the contents of a datapackage.json file in a human-friendly way directly in the terminal.
  • Use through the command line for convenience, speed, and automation.
  • Comes with multiple built-in styles and supports custom styles with Jinja2 templates.
  • Configurable through the .flower.toml file for reproducible document generation for your Data Package.

Flower focuses on generating documents. For rendering, publishing, or deploying, see our template-data-package.

About the Seedcase Project

Flower is part of the Seedcase Project, which helps research projects manage and process data in line with the FAIR principles.

This package works as a standalone tool but is also integrated into our template-data-package template, which makes it easier to set up, build, and manage a Data Package.

Check out Seedcase Explore the template

Want to contribute?

We would love your feedback or contributions! Head over to the GitHub repository to share your ideas or contribute code. Your input makes us better!