Skip to content
This repository has been archived by the owner on Sep 25, 2024. It is now read-only.

Commit

Permalink
style(README): apply format fix
Browse files Browse the repository at this point in the history
  • Loading branch information
SecondThundeR committed Apr 15, 2023
1 parent 5b7e13b commit de20899
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ asyncio.run(main())
```

Выполнение нескольких запросов одновременно с помощью метода `multiple_requests`:

```py
# В этом примере используется распаковка, но можно также получать весь массив с данными ответов
# в одной переменнной (chainsaw, lycoris_anime, ... -> data = await ...)
Expand Down Expand Up @@ -140,15 +141,15 @@ async def main():
Также, если хочется узнать как использовать встроенные хранилища конфигов или хочется создать свой,
посмотрите [этот гайд](https://github.com/SecondThundeR/shikithon/wiki/%D0%93%D0%B0%D0%B9%D0%B4-%D0%BF%D0%BE-%D1%85%D1%80%D0%B0%D0%BD%D0%B8%D0%BB%D0%B8%D1%89%D0%B0%D0%BC-%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B8)

#### Пара уточнений по использованию:
### Пара уточнений по использованию

- Возможно вам придется импортировать модели для ручной аннотации возвращаемых моделей в PyCharm
_(в нем немного некорретно работает наследование типа от функции)_
- При отсутствии каких-либо полей в данных конфигурации, библиотека выдает исключение
- Если вы хотите использовать логгирование библиотеки, передайте флаг `logging=True` в объект API:
`api = ShikimoriAPI(app_name="...", logging=True)`

### Получение данных для конфигурации
## Получение данных для конфигурации

Для начала вам необходимо создать новое OAuth-приложение [здесь](https://shikimori.me/oauth/applications).
После этого, сохраните `app_name`, `client_id`, `client_secret`, а так же `redirect_uri`, если вы его меняли
Expand Down Expand Up @@ -187,6 +188,7 @@ _(Если необходимо, то можно также получить т
[(Лицензия)](https://github.com/python/typing_extensions/blob/main/LICENSE)

Также, данный проект использует две библиотеки в качестве зависимостей для разработки:

- [pre-commit](https://github.com/pre-commit/pre-commit) для автоматизации форматирования и проверки кода
[(Лицензия)](https://github.com/pre-commit/pre-commit/blob/main/LICENSE)
- [mypy](https://github.com/python/mypy) для проверки типов [(Лицензия)](https://github.com/python/mypy/blob/master/LICENSE)
Expand Down

0 comments on commit de20899

Please sign in to comment.