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

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
SecondThundeR committed Jul 8, 2022
2 parents 9411a6f + 9f937da commit 5051d2b
Show file tree
Hide file tree
Showing 8 changed files with 129 additions and 282 deletions.
4 changes: 2 additions & 2 deletions .pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ output-format=text
# command line instead of printing them on stdout. Reports (if any) will be
# written in a file name "pylint_global.[txt|html]". This option is deprecated
# and it will be removed in Pylint 2.0.
files-output=no
# files-output=no

# Tells whether to display a full report or only the messages
reports=no
Expand Down Expand Up @@ -283,7 +283,7 @@ single-line-if-stmt=yes
# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
# `trailing-comma` allows a space between comma and closing bracket: (a, ).
# `empty-line` allows space-only lines.
no-space-check=
# no-space-check=

# Maximum number of lines in a module
max-module-lines=99999
Expand Down
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Пам-парам. Приветствую смотрящих!
# Пам-парам. Приветствую смотрящих

**Последнее изменение: 01.05.2022**
## Последнее изменение: 01.05.2022

Добро пожаловать в пометку контрибьютора.
Здесь изложены некоторые правила, которые помогут правильно оформить код в соответствиями с правилами проекта
Expand Down Expand Up @@ -62,6 +62,7 @@ _Кто-то дошел до этого момента? Удивительно..
4. Если вы используете какие-нибудь IDE, не забудьте настроить виртуальное окружение и там

Пользователям Windows нужно пройти пару этапов:

1. Установите [Python 3.8.10](https://www.python.org/downloads/release/python-3810/) и [последний Python](https://www.python.org/downloads/) на текущий момент
> Почему 3.8.10? А, просто для 3.8.13 нет нормальных установщиков :(
>
Expand All @@ -75,6 +76,7 @@ _Кто-то дошел до этого момента? Удивительно..
> Например: ```poetry env use "C:\Program Files\Python38\python.exe"```
Пользователям Linux нужно пройти пару этапов:

1. Установите Python 3.8.13 и Python 3.10
_(Лучше загуглить, чем писать тут как это делать под каждый дистрибутив)_
2. Установите Poetry используя [официальную команду](https://python-poetry.org/docs/#osx--linux--bashonwindows-install-instructions)
Expand All @@ -95,6 +97,7 @@ _(Лучше загуглить, чем писать тут как это дел
*_Но это не точно_

Чтож, вам осталось пройти пару этапов перед финальным ~~боссом~~ пулл реквестом:

1. Для начала, убедитесь, что ваши новые методы или классы имеют документацию _(можно даже базовую)_.

Данный проект использует документацию типа reStructuredText, пример которой вы можете найти в интернете или в имеющихся файлах.
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
## Пример использования

С использованием полного конфига:

```py
from json import loads
# Необязательно
Expand Down Expand Up @@ -93,6 +94,7 @@ print(user_achievements[0])
```

С использованием имени приложения:

```py
# Необязательно
from typing import List
Expand Down Expand Up @@ -147,10 +149,10 @@ print(user_achievements[0])
### Получение данных для конфигурации

Для начала вам необходимо создать новое OAuth-приложение [здесь](https://shikimori.one/oauth/applications)
*(После этого, сохраните `app_name`, `client_id`, `client_secret`, а так же `redirect_uri`)*
_(После этого, сохраните `app_name`, `client_id`, `client_secret`, а так же `redirect_uri`)_

Позже, [на данной странице](https://shikimori.one/oauth) выберите свое приложение, необходимые разрешения
и получите код авторизации *(После этого сохраните, `scopes` и `auth_code`)*
и получите код авторизации _(После этого сохраните, `scopes` и `auth_code`)_

**Теперь ваш файл конфигурации готов!**

Expand Down Expand Up @@ -186,6 +188,7 @@ print(user_achievements[0])
[(Лицензия)](https://github.com/Delgan/loguru/blob/master/LICENSE)

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

- [pylint](https://github.com/PyCQA/pylint) для статической проверки кода
[(Лицензия)](https://github.com/PyCQA/pylint/blob/main/LICENSE)
- [yapf](https://github.com/google/yapf) для форматирования кода
Expand Down
Loading

0 comments on commit 5051d2b

Please sign in to comment.