{"id":37660609,"url":"https://github.com/guardicode/service-kit","last_synced_at":"2026-01-16T11:48:36.214Z","repository":{"id":272370395,"uuid":"913989318","full_name":"guardicode/service-kit","owner":"guardicode","description":"A collection of functions and objects that help the Monkey team bootstrap, build, and maintain different services","archived":false,"fork":false,"pushed_at":"2025-11-13T19:11:29.000Z","size":326,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-11-13T20:14:31.494Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guardicode.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-08T18:27:13.000Z","updated_at":"2025-10-30T17:07:43.000Z","dependencies_parsed_at":"2025-02-21T14:24:19.686Z","dependency_job_id":"ec71863f-2cc0-4e4d-a189-44f29f9527ad","html_url":"https://github.com/guardicode/service-kit","commit_stats":null,"previous_names":["guardicode/service-kit"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/guardicode/service-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guardicode%2Fservice-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guardicode%2Fservice-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guardicode%2Fservice-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guardicode%2Fservice-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guardicode","download_url":"https://codeload.github.com/guardicode/service-kit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guardicode%2Fservice-kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2026-01-16T11:48:36.128Z","updated_at":"2026-01-16T11:48:36.210Z","avatar_url":"https://github.com/guardicode.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- START_GENERAL_DOCS --\u003e\n# Service-Kit Documentation\n\n![License](https://img.shields.io/github/license/guardicode/service-kit)\n\n\n 📌 Service-Kit is a collection of functions and objects designed to help the\nMonkey team bootstrap, build, and maintain various services efficiently.\n\n## Features\n\n- **Service Bootstrapping**: Provides templates and utilities to stand up\nnew services quickly.\n- **Common Utilities**: Provides common utilities for logging, configuration,\nand error handling.\n- **Service Configuration**: Provides a base class for service\nconfiguration that can be easily extended.\n- **Testing Support**: Provides utilities for testing services.\n\n### Submodules\n\n- **api**: Provides components for setting up an API with FastAPI\n- **base_model**: Provides a Pydantic BaseModel with extra features\n- **configuration**: Provides models, types, and utilities for configuring a service\n- **errors**: Enables exceptions using structured errors\n- **logging**: Provides a logger that enables structured logging\n\n\n## Getting started\n\n### Installation\n\nYou can install Service-Kit using [poetry](https://python-poetry.org/):\n\n```bash\n$ poetry add git+https://github.com/guardicode/service-kit.git\n```\n\nor by using pip:\n\n```bash\n$ pip install git+https://github.com/guardicode/service-kit.git\n```\n\n#### Extras\n\nService-Kit contains some functionality that is only available if extras are\ninstalled.\n\n- `service_kit.logging.log_postgres_error()` is only available if Service-Kit\n  is installed with the `[psycopg]` extra.\n- `service_kit.api` is only available if Serivce-Kit is installed with the\n  `[api]` extra.\n\nWhen installing with Poetry, this looks like:\n\n```bash\n$ poetry add --extras=api --extras=psycopg git+https://github.com/guardicode/service-kit.git\n```\n\nor with pip:\n\n```bash\n$ pip install git+https://github.com/guardicode/service-kit.git#egg=service-kit[api,psycopg]\n```\n\n### Usage\n\nAfter installation, you can start using Service-Kit like any other Python package.\nFor a more detailed example and usage patterns, refer to the\n`template_service.py` file included in the repository.\n\n\u003c!-- END_GENERAL_DOCS --\u003e\n\u003c!-- START_DEV_DOCS --\u003e\n## Development\n\n### Setting up your development environment\n\nRun the following commands to install the necessary prerequisites:\n\n```bash\n$ pip install poetry pre-commit\n$ poetry install --all-extras\n$ pre-commit install -t pre-commit -t prepare-commit-msg\n```\n\n### Running unit tests\n\nRun automated tests with:\n\n```bash\n$ poetry run pytest\n```\n\n\n#### Test coverage\n\nTo run automated tests with test coverage, run:\n\n```bash\n$ poetry run pytest --cov-report=html --cov=service-kit\n$ firefox ./htmlcov/index.html\n```\n\n### Sphinx Documentation\n\nThe `docs` directory contains the needed file to automatically generate code documentation using Sphinx.\n\n#### Configuration\n\nTo change the Sphinx configuration, change the attributes in `source/conf.py`.\nThe documentation uses `source/_static` to keep the custom media, stylesheets, js scripts etc.\n`source/index.rst` is the main rst file in which the look of the index HTML page is defined.\n\n#### Build\n\nThe make script generates the documentation using sphinx-build.\nThe generated documentation is stored in `build/html/`.\n\n##### Linux\n\n1. From `service-kit`, install python dependencies:\n\n```bash\n$ poetry install\n```\n\n1. Activate the python venv\n\n```bash\n$ poetry env activate\n```\n\n1. Generate the documentation:\n\n```bash\n$ cd docs\n$ make html\n```\n\n\n##### Windows\n\n1. From `service-kit`, install python dependencies:\n\n```bash\n$ poetry install\n```\n\n1. Activate the python venv\n\n```bash\n$ poetry env activate\n```\n\n1. Generate the documentation:\n\n```bash\n$ cd docs\n$ make html\n```\n\n\n#### Deployment\n\nTo deploy the documentation locally, `build/html/index.html`\n\u003c!-- END_DEV_DOCS --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguardicode%2Fservice-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguardicode%2Fservice-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguardicode%2Fservice-kit/lists"}