{"id":20280342,"url":"https://github.com/yezz123/fastapi-tag","last_synced_at":"2025-08-19T13:32:34.008Z","repository":{"id":57428509,"uuid":"420674174","full_name":"yezz123/fastapi-tag","owner":"yezz123","description":"Documented \u0026 Enhance the Metadata of your API ✨","archived":false,"fork":false,"pushed_at":"2024-11-18T18:20:49.000Z","size":133,"stargazers_count":38,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-08T15:23:03.872Z","etag":null,"topics":["fastapi","metadata","openapi","pydantic","pydantic-v2"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yezz123.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"yezz123","polar":"yezz123"}},"created_at":"2021-10-24T12:10:53.000Z","updated_at":"2024-08-19T22:07:29.000Z","dependencies_parsed_at":"2024-04-15T23:38:24.756Z","dependency_job_id":"4da4ab6b-692c-4e7c-86f1-a819a60923b2","html_url":"https://github.com/yezz123/fastapi-tag","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2Ffastapi-tag","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2Ffastapi-tag/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2Ffastapi-tag/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2Ffastapi-tag/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yezz123","download_url":"https://codeload.github.com/yezz123/fastapi-tag/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230355829,"owners_count":18213536,"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":["fastapi","metadata","openapi","pydantic","pydantic-v2"],"created_at":"2024-11-14T13:35:23.174Z","updated_at":"2024-12-19T00:09:54.587Z","avatar_url":"https://github.com/yezz123.png","language":"Python","funding_links":["https://github.com/sponsors/yezz123","https://polar.sh/yezz123"],"categories":[],"sub_categories":[],"readme":"# FastAPI Tag\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/yezz123/fastapi-tag\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/yezz123/fastapi-tag/main/.github/logo.png\" alt=\"FastAPI Tag\"\u003e\n\u003c/a\u003e\n\u003cp align=\"center\"\u003e\n    \u003cem\u003eDocumented \u0026 Enhance the Metadata of your API ✨\u003c/em\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/yezz123/fastapi-tag/actions/workflows/ci.yml\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://github.com/yezz123/fastapi-tag/actions/workflows/ci.yml/badge.svg\" alt=\"Continuous Integration\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://pypi.org/project/fastapi-tag\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/pgqb?color=%2334D058\u0026label=pypi%20package\" alt=\"Package version\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://codecov.io/gh/yezz123/fastapi-tag\"\u003e\n    \u003cimg src=\"https://codecov.io/gh/yezz123/fastapi-tag/branch/main/graph/badge.svg\"/\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\u003c/p\u003e\n\nA simple Package could be added to your FastAPI Project to enhance the metadata of your Project and documenting your API with more information.\n\n---\n\n**Source Code**: \u003chttps://github.com/yezz123/fastapi-tag\u003e\n\n**Install the project**: `pip install fastapi-tag`\n\n---\n\n## Features 🎉\n\n- Add a tag to your API, which can be used to filter the API documentation.\n- Add a description to your API, which can be used to describe the API.\n- Add a version to your API, which can be used to describe the version of the API and app.\n- Provide some others features like:\n  - `API_id`: A unique identifier for the API.\n  - `Audience`: The audience of the API (e.g. `public`, `internal`, `external`).\n- Tested in python 3.8 and up.\n- Last Version of FastAPI :rocket:\n\n## Usage 📚\n\n- To Identify the Metadata of your API:\n\n```py\nfrom fastapi import FastAPI\nfrom fastapi_tag.model import Contact, Metadata, Version\nfrom fastapi_tag.application import Application\n\napp = FastAPI()\n\ndef metadata(app):\n    return Metadata(\n        title=\"Hello World\",\n        version=Version(app=\"v0.1.1\", api=\"v0.1.0\"),\n        description=\"A simple example of a FastAPI application.\",\n        contact=Contact(\n            name=\"name\",\n            url=\"http://test.com\",\n            email=None\n        ),\n        api_id=\"49786b4b-1889-46ec-bd72-27f332436e6f\",\n        audience=\"company-internal\",\n    )\n\ndef app(metadata):\n    return Application(\"\", metadata)\n```\n\n- We have also `Problem` class thats depends on:\n  - `title`: The title of the problem.\n  - `status`: The status code of the problem.\n  - `detail`: A human-readable explanation specific to this occurrence of the problem.\n  - `instance`: A URI reference that identifies the specific occurrence of the problem.\n  - `type`: A URI reference that identifies the problem type.\n\n- `NameSpace` is a is a decorator that adds a route generator to the namespace object.\n\nfor example:\n\n```py\nfrom fastapi_tag.routers import Namespace\n\nroute = Namespace([])\n```\n\n## Development\n\n### Setup environment\n\nYou should create a virtual environment and activate it:\n\n\u003e **Notes:** You need to have `python3.9` or higher installed.\n\nI Use `uv` to manage virtual environments, you can install it with:\n\n```bash\n# Install uv\npip install uv\n\n# Create a virtual environment\nuv venv\n\n# Activate the virtual environment\nsource .venv/bin/activate\n```\n\nAnd then install the development dependencies:\n\n```bash\n# Install dependencies\nuv pip install -e .[test,lint]\n```\n\n### Run tests 🌝\n\nYou can run all the tests with:\n\n```bash\nbash scripts/tests.sh\n```\n\n### Format the code 🍂\n\nExecute the following command to apply `pre-commit` formatting:\n\n```bash\nbash scripts/format.sh\n```\n\n## License 🍻\n\nThis project is licensed under the terms of the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyezz123%2Ffastapi-tag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyezz123%2Ffastapi-tag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyezz123%2Ffastapi-tag/lists"}