From 44e7c414c408f55323cde8a791a4a79867f58fdb Mon Sep 17 00:00:00 2001 From: Grigoriev Semyon <33061489+grigoriev-semyon@users.noreply.github.com> Date: Sun, 24 Sep 2023 14:38:42 +0300 Subject: [PATCH 1/5] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 34fb2a8..7ca72e9 100644 --- a/README.md +++ b/README.md @@ -95,3 +95,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 From 0c5d4a5f8033b6dbd3ca0c7a47fea5d3cc9a0773 Mon Sep 17 00:00:00 2001 From: Grigoriev Semyon <33061489+grigoriev-semyon@users.noreply.github.com> Date: Sun, 24 Sep 2023 14:40:05 +0300 Subject: [PATCH 2/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cba2dcd..8dd1645 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. Закончили - коммитите изменения @@ -11,3 +17,8 @@ 3. Как работает Depends: https://fastapi.tiangolo.com/tutorial/dependencies/ 4. Разрабатывайте +## Codestyle + + - Black. Как пользоваться описано [тут](https://black.readthedocs.io/en/stable/) + + - Также применяем [isort](https://pycqa.github.io/isort/) From 1d129d0879c4b9366e170f3b6c21a5c5e9345cb9 Mon Sep 17 00:00:00 2001 From: Grigoriev Semyon <33061489+grigoriev-semyon@users.noreply.github.com> Date: Sun, 24 Sep 2023 14:41:10 +0300 Subject: [PATCH 3/5] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7ca72e9..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 From 413a6cf3460f8171057140f89ccf6c1e4eb929d0 Mon Sep 17 00:00:00 2001 From: Grigoriev Semyon <33061489+grigoriev-semyon@users.noreply.github.com> Date: Sun, 24 Sep 2023 14:55:32 +0300 Subject: [PATCH 4/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8dd1645..96f8bdc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,8 +14,16 @@ ## Как контрибьютить 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 From e6f64fb7a015928ffe120d60fdb13ecbe83fb83d Mon Sep 17 00:00:00 2001 From: Grigoriev Semyon <33061489+grigoriev-semyon@users.noreply.github.com> Date: Sat, 30 Sep 2023 02:57:45 +0300 Subject: [PATCH 5/5] typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96f8bdc..61971f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ 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 +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.