seedcase-flower: Turn your Data Package metadata into human-readable documentation

Flower is a Python package and command-line interface (CLI) that generates human-friendly documentation from your machine-readable Data Package 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-based Markdown files that you can use to create a website, a PDF, or any other format supported by Quarto.

Check out the website 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 Seedcase template 🎉

Project files and folders

• .github/: Contains GitHub-specific files, such as issue and pull request templates, workflows, dependabot configuration, pull request templates, and a CODEOWNERS file.
• tools/vulture-allowlist.py: List of variables that shouldn’t be flagged by 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 renderer.
• pytest.ini: Pytest configuration file.
• mypy.ini: mypy 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 configuration file for managing versions and changelogs.
• .pre-commit-config.yaml: Pre-commit configuration file for managing and running checks before each commit.
• .typos.toml: typos spell checker configuration file.
• justfile: just configuration file for scripting project tasks.
• .editorconfig: Editor configuration file for EditorConfig 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 configuration file for linting and formatting Python code.
• uv.lock: Lockfile used by uv to record exact versions of installed dependencies.
• .rumdl.toml: rumdl configuration file for formatting Markdown files so that they are standardized and consistent

Contributing

Check out our contributing document 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. 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 🎉

@joelostblom, @lwjohnst86, @martonvago, @signekb

Licensing

This project is licensed under the MIT License.

Changelog

For a list of changes, see our changelog page.