| Name | autoapi-django JSON |
| Version |
0.11.4
JSON |
| download |
| home_page | |
| Summary | Library for generating transport logic for web application |
| upload_time | 2023-08-17 11:32:55 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | The MIT License (MIT) Copyright (c) 2018 Sebastián Ramírez Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
api
django
swagger
openapi
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AutoAPI
AutoAPI собирает абстрагирует ваше приложение от слоя с передачей данных,
генерируя API из чистых классов, содержащих логику.
## Документация
- [Russian](./docs/autoapi/index.md)
- English (in future)
## Развертывание на локалке
Устанавливаем virtual env:
```shell
python3 -m venv venv
. venv/bin/activate
```
Устанавливаем библиотеку с зависимостями
```shell
pip install .
```
Переходим в example-проект, мигрируем БД (SQLite) и запускаем:
```shell
cd example/online_shop
python manage.py migrate
python manage.py runserver
```
По урле http://127.0.0.1:8000/docs/ будет доступен Swagger для сгенерированного API.
Оттуда можно дергать хэндлеры.
Рекомендуется создать суперюзера (`python manage.py createsuperuser`) и авторизоваться в админке.
Чтобы проверить корректную работу API, можно дернуть хэндлер `user.get_user` в сваггере.
Для билда и отправки в PyPI надо сделать:
```shell
pip install build
python -m build
pip install twine
twine upload dist/*
```
Raw data
{
"_id": null,
"home_page": "",
"name": "autoapi-django",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "api,django,swagger,openapi",
"author": "",
"author_email": "Artem Romanukov <vens148@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0d/f0/a05498ac1d0452ac2f55c56489d7646d828264dc8508359cecad04e09228/autoapi-django-0.11.4.tar.gz",
"platform": null,
"description": "# AutoAPI\n\nAutoAPI \u0441\u043e\u0431\u0438\u0440\u0430\u0435\u0442 \u0430\u0431\u0441\u0442\u0440\u0430\u0433\u0438\u0440\u0443\u0435\u0442 \u0432\u0430\u0448\u0435 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u043e\u0442 \u0441\u043b\u043e\u044f \u0441 \u043f\u0435\u0440\u0435\u0434\u0430\u0447\u0435\u0439 \u0434\u0430\u043d\u043d\u044b\u0445,\n\u0433\u0435\u043d\u0435\u0440\u0438\u0440\u0443\u044f API \u0438\u0437 \u0447\u0438\u0441\u0442\u044b\u0445 \u043a\u043b\u0430\u0441\u0441\u043e\u0432, \u0441\u043e\u0434\u0435\u0440\u0436\u0430\u0449\u0438\u0445 \u043b\u043e\u0433\u0438\u043a\u0443.\n\n## \u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f\n\n- [Russian](./docs/autoapi/index.md)\n- English (in future)\n\n## \u0420\u0430\u0437\u0432\u0435\u0440\u0442\u044b\u0432\u0430\u043d\u0438\u0435 \u043d\u0430 \u043b\u043e\u043a\u0430\u043b\u043a\u0435\n\n\u0423\u0441\u0442\u0430\u043d\u0430\u0432\u043b\u0438\u0432\u0430\u0435\u043c virtual env:\n\n```shell\npython3 -m venv venv\n. venv/bin/activate\n```\n\n\u0423\u0441\u0442\u0430\u043d\u0430\u0432\u043b\u0438\u0432\u0430\u0435\u043c \u0431\u0438\u0431\u043b\u0438\u043e\u0442\u0435\u043a\u0443 \u0441 \u0437\u0430\u0432\u0438\u0441\u0438\u043c\u043e\u0441\u0442\u044f\u043c\u0438\n```shell\npip install .\n```\n\n\u041f\u0435\u0440\u0435\u0445\u043e\u0434\u0438\u043c \u0432 example-\u043f\u0440\u043e\u0435\u043a\u0442, \u043c\u0438\u0433\u0440\u0438\u0440\u0443\u0435\u043c \u0411\u0414 (SQLite) \u0438 \u0437\u0430\u043f\u0443\u0441\u043a\u0430\u0435\u043c:\n```shell\ncd example/online_shop\npython manage.py migrate\npython manage.py runserver\n```\n\n\u041f\u043e \u0443\u0440\u043b\u0435 http://127.0.0.1:8000/docs/ \u0431\u0443\u0434\u0435\u0442 \u0434\u043e\u0441\u0442\u0443\u043f\u0435\u043d Swagger \u0434\u043b\u044f \u0441\u0433\u0435\u043d\u0435\u0440\u0438\u0440\u043e\u0432\u0430\u043d\u043d\u043e\u0433\u043e API.\n\u041e\u0442\u0442\u0443\u0434\u0430 \u043c\u043e\u0436\u043d\u043e \u0434\u0435\u0440\u0433\u0430\u0442\u044c \u0445\u044d\u043d\u0434\u043b\u0435\u0440\u044b.\n\n\u0420\u0435\u043a\u043e\u043c\u0435\u043d\u0434\u0443\u0435\u0442\u0441\u044f \u0441\u043e\u0437\u0434\u0430\u0442\u044c \u0441\u0443\u043f\u0435\u0440\u044e\u0437\u0435\u0440\u0430 (`python manage.py createsuperuser`) \u0438 \u0430\u0432\u0442\u043e\u0440\u0438\u0437\u043e\u0432\u0430\u0442\u044c\u0441\u044f \u0432 \u0430\u0434\u043c\u0438\u043d\u043a\u0435.\n\u0427\u0442\u043e\u0431\u044b \u043f\u0440\u043e\u0432\u0435\u0440\u0438\u0442\u044c \u043a\u043e\u0440\u0440\u0435\u043a\u0442\u043d\u0443\u044e \u0440\u0430\u0431\u043e\u0442\u0443 API, \u043c\u043e\u0436\u043d\u043e \u0434\u0435\u0440\u043d\u0443\u0442\u044c \u0445\u044d\u043d\u0434\u043b\u0435\u0440 `user.get_user` \u0432 \u0441\u0432\u0430\u0433\u0433\u0435\u0440\u0435.\n\n\n\u0414\u043b\u044f \u0431\u0438\u043b\u0434\u0430 \u0438 \u043e\u0442\u043f\u0440\u0430\u0432\u043a\u0438 \u0432 PyPI \u043d\u0430\u0434\u043e \u0441\u0434\u0435\u043b\u0430\u0442\u044c:\n```shell\npip install build\npython -m build\npip install twine\ntwine upload dist/*\n```\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2018 Sebasti\u00e1n Ram\u00edrez Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Library for generating transport logic for web application",
"version": "0.11.4",
"project_urls": {
"documentation": "https://github.com/romanukov/autoapi/",
"homepage": "https://github.com/romanukov/autoapi/",
"repository": "https://github.com/romanukov/autoapi/"
},
"split_keywords": [
"api",
"django",
"swagger",
"openapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "34d0f3bb0da8270fae973e2abce1583acfa203953cecde5d87290286270e0865",
"md5": "ea78363b97fbce71fb9533648eab11c5",
"sha256": "f204f108c6fc29d44b4ef3acc6ec01c9f047a5817c427808bae413f8f6fe547b"
},
"downloads": -1,
"filename": "autoapi_django-0.11.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea78363b97fbce71fb9533648eab11c5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 40829,
"upload_time": "2023-08-17T11:32:53",
"upload_time_iso_8601": "2023-08-17T11:32:53.472921Z",
"url": "https://files.pythonhosted.org/packages/34/d0/f3bb0da8270fae973e2abce1583acfa203953cecde5d87290286270e0865/autoapi_django-0.11.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0df0a05498ac1d0452ac2f55c56489d7646d828264dc8508359cecad04e09228",
"md5": "641d9aaad012dffb4b26775f09867152",
"sha256": "39c7ca8a3055a7737ff8b58d63b3be0f1bb3a792b5aba381c398b4b374048d8f"
},
"downloads": -1,
"filename": "autoapi-django-0.11.4.tar.gz",
"has_sig": false,
"md5_digest": "641d9aaad012dffb4b26775f09867152",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 22755,
"upload_time": "2023-08-17T11:32:55",
"upload_time_iso_8601": "2023-08-17T11:32:55.477723Z",
"url": "https://files.pythonhosted.org/packages/0d/f0/a05498ac1d0452ac2f55c56489d7646d828264dc8508359cecad04e09228/autoapi-django-0.11.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-17 11:32:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "romanukov",
"github_project": "autoapi",
"github_not_found": true,
"lcname": "autoapi-django"
}
