معرفی شرکت ها
fastapi_tag-0.0.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
FastAPI Tag: is a Module for fastapi help to ensure the Metadata of the API.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | fastapi_tag-0.0.1 |
| نام | fastapi_tag |
| نسخه کتابخانه | 0.0.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Yasser Tahiri |
| ایمیل نویسنده | yasserth19@gmail.com |
| آدرس صفحه اصلی | https://github.com/yezz123/fastapi-tag |
| آدرس اینترنتی | https://pypi.org/project/fastapi_tag/ |
| مجوز | - |
# FastAPI Tag
[](https://github.com/yezz123/fastapi-tag/actions/workflows/tests.yml)
[](https://github.com/yezz123/fastapi-tag/actions/workflows/release.yml)
[](https://codecov.io/gh/yezz123/fastapi-tag)
[](https://badge.fury.io/py/fastapi-tag)
[](https://fastapi.tiangolo.com/)
[](https://pypi.org/project/fastapi-tag)
<p align="center">
<em>Documented & Enhance the Metadata of your API ✨</em>
</p>
A simple Package could be added to your FastAPI Project to enhance the metadata of your Project and documenting your API with more information.
---
**Source Code**: <https://github.com/yezz123/fastapi-tag>
**Install the project**: `pip install fastapi-tag`
---
## Features 🎉
- Add a tag to your API, which can be used to filter the API documentation.
- Add a description to your API, which can be used to describe the API.
- Add a version to your API, which can be used to describe the version of the API and app.
- Provide some others features like:
- `API_id`: A unique identifier for the API.
- `Audience`: The audience of the API (e.g. `public`, `internal`, `external`).
- Tested in python 3.6 and up.
- Last Version of FastAPI :rocket:
## Usage 📚
- To Identify the Metadata of your API:
```py
from fastapi import FastAPI
from fastapi_tag.base.model import Contact, Metadata, Version
from fastapi_tag.core.application import Application
app = FastAPI()
def metadata(app):
return Metadata(
title="Hello World",
version=Version(app="v0.1.1", api="v0.1.0"),
description="A simple example of a FastAPI application.",
contact=Contact(
name="name",
url="http://test.com",
email=None
),
api_id="49786b4b-1889-46ec-bd72-27f332436e6f",
audience="company-internal",
)
def app(metadata):
return Application("", metadata)
```
- We have also `Problem` class thats depends on:
- `title`: The title of the problem.
- `status`: The status code of the problem.
- `detail`: A human-readable explanation specific to this occurrence of the problem.
- `instance`: A URI reference that identifies the specific occurrence of the problem.
- `type`: A URI reference that identifies the problem type.
- `NameSpace` is a is a decorator that adds a route generator to the namespace object.
for example:
```py
from fastapi_tag.router.routers import Namespace
route = Namespace([])
```
### Format the code 💅
Execute the following command to apply `pre-commit` formatting:
```bash
make lint
```
## TODO 🚧
- Extend the `Problem` class to add more information.
- Add more features to the `Metadata` class.
- Add more features to the `Version` class.
- Provide a detailed documentation for `fastapi_tag` package.
## License 🍻
This project is licensed under the terms of the MIT license.
نیازمندی
| مقدار | نام |
|---|---|
| - | anyio==3.4.0 |
| - | fastapi==0.70.0 |
| - | idna==3.3 |
| - | pydantic==1.8.2 |
| - | sniffio==1.2.0 |
| - | starlette==0.16.0 |
| - | typing_extensions==4.0.1 |
| - | mock==4.0.3 |
| - | pytest==6.2.5 |
| - | coverage==6.2 |
| - | requests==2.26.0 |
| - | requests-toolbelt==0.9.1 |
| - | pytest-asyncio==0.16.0 |
| - | uvicorn==0.15.0 |
| - | pre-commit==2.16.0 |
| - | asynctest==0.13.0 |
| - | bumpversion==0.6.0 |
| - | codecov==2.1.12 |
| - | pytest-cov==3.0.0 |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.6 | Python |
نحوه نصب
نصب پکیج whl fastapi_tag-0.0.1:
pip install fastapi_tag-0.0.1.whl
نصب پکیج tar.gz fastapi_tag-0.0.1:
pip install fastapi_tag-0.0.1.tar.gz