diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cba2dcd..61971f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,9 @@ +## Что нужно для запуска + + 1. python3.11. Установка описана [тут](https://www.python.org/downloads/) + + 2. Завсимости, описанные в setup.py, requirements.dev.txt + ## Как тестировать при разработке 1. Создаете ветку в репозитории, разрабатываете там 2. Закончили - коммитите изменения @@ -8,6 +14,19 @@ ## Как контрибьютить 1. `git clone https://github.com/profcomff/auth-lib.git` 2. Создавайте ветку -3. Как работает Depends: https://fastapi.tiangolo.com/tutorial/dependencies/ -4. Разрабатывайте +### Если хотите добавить новый общий метод +3. Написать этот метод в файл /auth_lib/methods.py - синхронная версия и, если есть возможность, в файл /auth_lib/aiomethods/py - асинхронная версия +4. Протестировать метод на локальном/тестовом АПИ +### Если хотите добавить логику в общий класс порверки аутентификации и авторизации +3. Прочитайте как работает Depends: https://fastapi.tiangolo.com/tutorial/dependencies/ +4. Нужная вам логика описана в /auth_lib/fastapi.py. Основной метод - __call__.py. +### Если хотите поменять логику тестирования библиотеки +3. Прочитайте про используемые в этой библиотеке [моки](https://docs.python.org/3/library/unittest.mock.html#unittest.mock.patch) из unittest +4. Прочитайте про [pytest fixtures](https://docs.pytest.org/en/6.2.x/fixture.html#what-fixtures-are). [Это](https://habr.com/ru/articles/448786/) тоже неплохая статья. +5. Нужная вам логика описана в /auth_lib/testing/testutils.py. + +## Codestyle + + - Black. Как пользоваться описано [тут](https://black.readthedocs.io/en/stable/) + - Также применяем [isort](https://pycqa.github.io/isort/) diff --git a/README.md b/README.md index 34fb2a8..75fcb48 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ [![pypi](https://img.shields.io/pypi/dm/auth-lib-profcomff?label=PIP%20INSTALLS&style=for-the-badge)](https://pypi.org/project/auth-lib-profcomff) [![tg](https://img.shields.io/badge/telegram-Viribus%20unitis-brightgreen?style=for-the-badge&logo=telegram)](https://t.me/+eIMtCymYDepmN2Ey) + +## Функционал +Хранение общих методов аутентификации и авторизации для бэкендов Твой ФФ + ## Примеры использования ### FastAPI ```python @@ -95,3 +99,8 @@ def test3(client): """ assert 2*2 == 4 ``` + +## Contributing + - Основная [информация](https://github.com/profcomff/.github/wiki/%255Bdev%255D-Backend-%25D1%2580%25D0%25B0%25D0%25B7%25D1%2580%25D0%25B0%25D0%25B1%25D0%25BE%25D1%2582%25D0%25BA%25D0%25B0) по разработке наших приложений + + - [Ссылка](https://github.com/profcomff/auth-lib/blob/main/CONTRIBUTING.md) на страницу с информацией по разработке auth-lib