Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 1.52 KB

README.md

File metadata and controls

51 lines (39 loc) · 1.52 KB

Dahlia spec Poetry Ruff

Dahlia

Dahlia is a simple text formatting package, inspired by text formatting in the game Minecraft.

Installation

Dahlia is available on PyPI and can be installed with pip, or any other Python package manager:

$ pip install dahlia

(Some systems may require you to use pip3, python -m pip, or py -m pip instead)

Contributing

Contributions are welcome!

Please open an issue before submitting a pull request (doesn't apply to minor changes like typos).

To get started:

  1. Clone your fork of the project.
  2. Install the project with uv:
uv sync
  1. After you're done, use the following just recipes to check your changes (or run the commands manually):
just check     # pytest, mypy, ruff
just coverage  # pytest (with coverage), interrogate (docstring coverage)

License

Dahlia is licensed under the MIT License.

If you have any questions, or would like to get in touch, join my Discord server!