ya7on / pych Goto Github PK

Вряд ли кому-то англоговорящему понадобится эта библиотека, поэтому лучше сразу всю документацию перевести на великий и могучий.

Нужно создать медод .create(*args, **kwargs) у класса pych.catalog.Catalog(), который будет отвечать за создание нового треда. Отправлять запрос он должен на тот же эндпоинт, который отвечает за постинг сообщений в тред, поэтому можно подглядеть в предыдущий ишью, в котором я описал принцип работы отправки сообщений в тред.
Здесь будет то же самое, только атрибут thread будет равен 0, а не айдишнику родительского треда.

Предыдущий ишью, в котором больше информации #12

Create module with dict, that will contain information about known boards

Значение Catalog().threads теперь должно возвращать новый класс, наследуемый от типа list. Этот класс будет:

• содержать все треды, которые есть в этом каталоге;
• называться, например, ThreadsList;
• иметь методы .find, который будет возвращать один найденый по указанным критериям, и .filter, который будет возвращать ThreadsList с отфильтрованными тредами.
  Эти методы должны принимать 1 аргумент с лямбда-функцией для фильтрации (как build-in функции filter, map и т.д.).

Примерно должно выглядеть как QuerySet в django.

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

>>> threads = Catalog('test').threads
>>> threads.filter(lambda thread: 'webm' in thread.comment)
<ThreadsList [список отфильтрованных тредов]>

Нужно добавить метод .tobytes() -> bytes у класса pych.file.File(), который будет получать файл по URL и возвращать тип данных bytes.
У типа requests.Response есть атрибут .content, который вернет байткод файла.

Posts:

• banned
• closed
• endless
• sticky
• trip
• parent

Files:

• nsfw

Нужно добавить глобальную настройку, которая будет пускать все запросы к API через пользовательские прокси.
Нужны предложения как это будет выглядеть.

https://github.com/BehindLoader/py2ch/blob/c7979dee065cbe75ef23b834d25dc8fea3e25b59/py2ch/file.py#L10

Нужно оставить только один README вместо имеющихся сейчас двух (md и rst).

1. Markdown формат не поддерживается в PyPi, поэтому его оставлять не очень хочется.
2. reStructuredText поддерживается PyPi и GitHub, и имеет подстветку синтаксиса для питона, поэтому останавливаемся на нём.

Сейчас вся имеющаяся документация находится в README.md. Можно попробовать использовать автоматические конвертеры из markdown в restructuredtext, если таковые имеются.

Acceptable types can be seen in the tests.

Add docs, example of using and guide for developers

Нужно добавить метод .download(destination: str) -> None: для класса pych.file.File().
Метод принимает один аргумент destination, который является путём к месту, куда необходимо сохранить файл. URL файла есть в атрибутах класса. Пользоваться надо только библиотекой requests, которая уже находится в зависимостя.

Нужно добавить метод .post(*args, **kwargs) у класса pych.thread.Thread(), который позволит отправить пост в тред, к которому привязан класс

Принимать должен все параметры, которые принимает эндпоинт и на которые может влиять пользователь. То есть, давать возможность изменять параметр thread или json не надо.

Нормальной документации у Двача нет, есть только короткий текст про ридонли эндпоинты в /api/.

Но можно найти старые треды, где упоминается эндпоинт https://2ch.hk/makaba/posting.fcgi, который обсуждался здесь.

Также есть Github gist, в котором на JS описан алгоритм создания нового треда, который отличается от постинга в тред одним параметром thread (0 - новый тред, айди OP для ответа в тред)
Вот собственно сам гист