The living-doc-utilities library contains core utility functions and shared data models used across the Living Documentation GitHub Actions ecosystem.
It provides:
- Reusable transformation and helper logic
- Serialization and deserialization (serde) utilities
- Common structured data models for consistent cross-action communication
- A foundation for expanding shared functionality in the future
It is designed to reduce duplication, improve testability, and simplify maintenance across the ecosystem.
Before installing this library, ensure you have:
- Python 3.12 or later
- pip package installer
- (Recommended) Virtual environment setup in your project
You can install the utilities locally or directly from GitHub.
If you are developing the library alongside another project:
pip install -e ../living-doc-utilitiesMake sure you activate the virtual environment in your main project before installing.
pip install git+https://github.com/AbsaOSS/[email protected]Once published to PyPI, simply run:
pip install living-doc-utilitiesTo pin a specific version:
pip install living-doc-utilities==0.1.0See this Developer Guide for more technical, development-related information.
We welcome contributions to the Living Documentation Generator! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.
Before contributing, please review our contribution guidelines for more detailed information.
This project is licensed under the Apache License 2.0. It is a liberal license that allows you great freedom in using, modifying, and distributing this software, while also providing an express grant of patent rights from contributors to users.
For more details, see the LICENSE file in the repository.
If you need help with using or contributing to the Living Documentation Generator Action, or if you have any questions or feedback, don't hesitate to reach out:
- Issue Tracker: For technical issues or feature requests, use the GitHub Issues page.
- Discussion Forum: For general questions and discussions, join our GitHub Discussions forum.