{"id":28914262,"url":"https://github.com/absaoss/living-doc-utilities","last_synced_at":"2026-03-16T17:31:51.851Z","repository":{"id":291916194,"uuid":"970756627","full_name":"AbsaOSS/living-doc-utilities","owner":"AbsaOSS","description":"Core utility functions and data models shared across the living-doc ecosystem. Provides structured model classes, reusable transformation logic, and serialization/deserialization (serde) utilities to support data exchange between components.","archived":false,"fork":false,"pushed_at":"2025-06-10T10:23:25.000Z","size":122,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-10T11:32:47.778Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AbsaOSS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-22T13:44:28.000Z","updated_at":"2025-06-09T07:10:18.000Z","dependencies_parsed_at":"2025-06-02T11:35:42.295Z","dependency_job_id":"23597c6f-97c9-42f7-950a-dd13bec18e46","html_url":"https://github.com/AbsaOSS/living-doc-utilities","commit_stats":null,"previous_names":["absaoss/living-doc-utilities"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/AbsaOSS/living-doc-utilities","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fliving-doc-utilities","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fliving-doc-utilities/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fliving-doc-utilities/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fliving-doc-utilities/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AbsaOSS","download_url":"https://codeload.github.com/AbsaOSS/living-doc-utilities/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fliving-doc-utilities/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261199991,"owners_count":23123917,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-21T21:41:22.712Z","updated_at":"2025-10-13T06:16:02.614Z","avatar_url":"https://github.com/AbsaOSS.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Living Documentation Utilities\n\n- [Motivation](#motivation)\n- [Usage](#usage)\n    - [Prerequisites](#prerequisites)\n    - [Installation](#installation)\n        - [Option 1: Local Development (editable mode)](#option-1-local-development-editable-mode)\n        - [Option 2: From GitHub (using a release tag)](#option-2-from-github-using-a-release-tag)\n        - [Option 3: From PyPI](#option-3-from-pypi)\n- [Developer Guide](#developer-guide)\n- [Contribution Guidelines](#contribution-guidelines)\n    - [How to Contribute](#how-to-contribute)\n    - [License Information](#license-information)\n    - [Contact or Support Information](#contact-or-support-information)\n\n\n## Motivation\n\nThe `living-doc-utilities` library contains core utility functions and shared data models used across the Living Documentation GitHub Actions ecosystem.\nIt provides:\n\n- Reusable transformation and helper logic\n- Serialization and deserialization (serde) utilities\n- Common structured data models for consistent cross-action communication\n- A foundation for expanding shared functionality in the future\n\nIt is designed to reduce duplication, improve testability, and simplify maintenance across the ecosystem.\n\n\n---\n## Usage\n\n### Prerequisites\n\nBefore installing this library, ensure you have:\n\n- Python 3.12 or later\n- pip package installer\n- (Recommended) Virtual environment setup in your project\n\n### Installation\n\nYou can install the utilities locally or directly from GitHub.\n\n#### Option 1: Local Development (editable mode)\n\nIf you are developing the library alongside another project:\n\n```bash\npip install -e ../living-doc-utilities\n```\n\nMake sure you activate the virtual environment in your main project before installing.\n\n#### Option 2: From GitHub (using a release tag)\n\n```bash\npip install git+https://github.com/AbsaOSS/living-doc-utilities@v0.1.0\n```\n\n#### Option 3: From PyPI\n\nOnce published to PyPI, simply run:\n\n```bash\npip install living-doc-utilities\n```\n\nTo pin a specific version:\n\n```bash\npip install living-doc-utilities==0.1.0\n```\n\n---\n\n## Developer Guide\n\nSee this [Developer Guide](DEVELOPER.md) for more technical, development-related information.\n\n---\n## Contribution Guidelines\n\nWe welcome contributions to the Living Documentation Generator! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.\n\n#### How to Contribute\n\nBefore contributing, please review our [contribution guidelines](https://github.com/AbsaOSS/living-doc-utilities/blob/master/CONTRIBUTING.md) for more detailed information.\n\n### License Information\n\nThis 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.\n\nFor more details, see the [LICENSE](https://github.com/AbsaOSS/living-doc-utilities/blob/master/LICENSE) file in the repository.\n\n### Contact or Support Information\n\nIf 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:\n\n- **Issue Tracker**: For technical issues or feature requests, use the [GitHub Issues page](https://github.com/AbsaOSS/living-doc-utilities/issues).\n- **Discussion Forum**: For general questions and discussions, join our [GitHub Discussions forum](https://github.com/AbsaOSS/living-doc-utilities/discussions).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabsaoss%2Fliving-doc-utilities","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabsaoss%2Fliving-doc-utilities","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabsaoss%2Fliving-doc-utilities/lists"}