https://github.com/seedcase-project/seedcase-flower
Turn your metadata into human-readable documentation
https://github.com/seedcase-project/seedcase-flower
data-package datapackage documentation-generator markdown-generator
Last synced: about 1 month ago
JSON representation
Turn your metadata into human-readable documentation
- Host: GitHub
- URL: https://github.com/seedcase-project/seedcase-flower
- Owner: seedcase-project
- License: mit
- Created: 2025-11-30T15:54:44.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-04-30T07:44:11.000Z (about 1 month ago)
- Last Synced: 2026-04-30T09:21:16.120Z (about 1 month ago)
- Topics: data-package, datapackage, documentation-generator, markdown-generator
- Language: Python
- Homepage: https://flower.seedcase-project.org
- Size: 3.14 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# seedcase-flower: Turn your metadata into human-readable documentation
[](https://doi.org/10.5281/zenodo.19220976)
[](https://pypi.org/project/seedcase-flower/)
[](https://github.com/copier-org/copier)
[](https://github.com/seedcase-project/seedcase-flower/blob/main/pyproject.toml)
[](https://github.com/seedcase-project/seedcase-flower/blob/main/LICENSE.md)
[](https://github.com/seedcase-project/seedcase-flower/releases/latest)
[](https://github.com/seedcase-project/seedcase-flower/actions/workflows/build-website.yml)
[](https://github.com/seedcase-project/seedcase-flower/actions/workflows/check-package.yml)
[](https://scorecard.dev/viewer/?uri=github.com/seedcase-project/seedcase-flower)
[](https://github.com/seedcase-project/seedcase-flower/actions/workflows/github-code-scanning/codeql)
[](https://htmlpreview.github.io/?https://raw.githubusercontent.com/seedcase-project/seedcase-flower/coverage/index.html)
[](https://results.pre-commit.ci/latest/github/seedcase-project/seedcase-flower/main)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://www.repostatus.org/#active)
Flower is a Python package and command-line interface (CLI) that
generates human-friendly documentation from your machine-readable [Data
Package](https://datapackage.org) metadata (kept within
`datapackage.json`). Flower does two things:
- Display the metadata in a nicer way on the Terminal with the `view`
command.
- Generate documentation files using built-in or custom styles with the
`build` command.
For building documentation, Flower reads the metadata and outputs it
into a nicer, more human-centric format. You can choose the output style
and structure by using either one of the built-in styles or define a
custom style yourself. By default, Flower outputs
[Quarto](https://quarto.org/)-based Markdown files that you can use to
create a website, a PDF, or any other format supported by
[Quarto](https://quarto.org/).
Check out the [website](https://flower.seedcase-project.org/) for more
information about the project, including the design of it, how to use
it, and a reference to the API.
> [!TIP]
>
> This Python package was generated from the
> [`template-python-package`](https://github.com/seedcase-project/template-python-package)
> Seedcase template :tada:
## Project files and folders
- `.github/`: Contains GitHub-specific files, such as issue and pull
request templates, workflows,
[dependabot](https://docs.github.com/en/code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide)
configuration, pull request templates, and a
[CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)
file.
- `tools/vulture-allowlist.py`: List of variables that shouldn’t be
flagged by [Vulture](https://github.com/jendrikseipp/vulture) as
unused.
- `tools/get-contributors.sh`: Script to get list of project
contributors.
- `tests/`: Test files for the package.
- `src/`: Source code for the package.
- `docs/`: Documentation about using and developing the Python package.
- `_renderer.py`: Custom
[`quartodoc`](https://machow.github.io/quartodoc/) renderer.
- `pytest.ini`: Pytest configuration file.
- `mypy.ini`: [`mypy`](https://mypy.readthedocs.io/en/stable/)
configuration file for type checking Python code.
- `.copier-answers.yml`: Contains the answers you gave when copying the
project from the template. **You should not modify this file
directly.**
- `.cz.toml`:
[Commitizen](https://commitizen-tools.github.io/commitizen/)
configuration file for managing versions and changelogs.
- `.pre-commit-config.yaml`: [Pre-commit](https://pre-commit.com/)
configuration file for managing and running checks before each commit.
- `.typos.toml`: [typos](https://github.com/crate-ci/typos) spell
checker configuration file.
- `justfile`: [`just`](https://just.systems/man/en/) configuration file
for scripting project tasks.
- `.editorconfig`: Editor configuration file for
[EditorConfig](https://editorconfig.org/) to maintain consistent
coding styles across different editors and IDEs.
- `CHANGELOG.md`: Changelog file for tracking changes in the project.
- `CITATION.cff`: Structured citation metadata for your project.
- `CONTRIBUTING.md`: Guidelines for contributing to the project.
- `_metadata.yml`: Quarto metadata file for the website, including
information about the project, such as the titles and GitHub names.
- `pyproject.toml`: Main Python project configuration file defining
metadata and dependencies.
- `_quarto.yml`: Quarto configuration file for the website, including
settings for the website, such as the theme, navigation, and other
options.
- `ruff.toml`: [Ruff](https://docs.astral.sh/ruff/) configuration file
for linting and formatting Python code.
- `uv.lock`: Lockfile used by [`uv`](https://docs.astral.sh/uv/) to
record exact versions of installed dependencies.
- `.rumdl.toml`: [rumdl](https://rumdl.dev/) configuration file for
formatting Markdown files so that they are standardized and consistent
## Contributing
Check out our [contributing document](CONTRIBUTING.md) for information
on how to contribute to the project, including how to set up your
development environment.
Please note that this project is released with a [Contributor Code of
Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree
to abide by its terms.
### Contributors
The following people have contributed to this project by submitting pull
requests :tada:
[@joelostblom](https://github.com/joelostblom),
[@lwjohnst86](https://github.com/lwjohnst86),
[@martonvago](https://github.com/martonvago),
[@signekb](https://github.com/signekb)
## Licensing
This project is licensed under the [MIT License](LICENSE.md).
## Changelog
For a list of changes, see our [changelog](CHANGELOG.md) page.