docs: add plans
This commit is contained in:
68
README.md
68
README.md
@@ -19,36 +19,6 @@ c = ITDClient('TOKEN', 'refresh_token=...; __ddg1_=...; __ddgid_=...; is_auth=1;
|
|||||||
print(c.get_me())
|
print(c.get_me())
|
||||||
```
|
```
|
||||||
|
|
||||||
### Встроенные запросы
|
|
||||||
Существуют встроенные эндпоинты для комментариев, хэштэгов, уведомлений, постов, репортов, поиска, пользователей, итд.
|
|
||||||
```python
|
|
||||||
c.get_user('ITD_API') # получение данных пользователя
|
|
||||||
c.get_me() # получение своих данных (me)
|
|
||||||
c.update_profile(display_name='22:26') # изменение данных профиля, например имя, био итд
|
|
||||||
c.create_post('тест1') # создание постов
|
|
||||||
# итд
|
|
||||||
```
|
|
||||||
|
|
||||||
### Кастомные запросы
|
|
||||||
|
|
||||||
```python
|
|
||||||
from itd.request import fetch
|
|
||||||
|
|
||||||
fetch(c.token, 'метод', 'эндпоинт', {'данные': 'данные'})
|
|
||||||
```
|
|
||||||
Из методов поддерживается `get`, `post`, `put` итд, которые есть в `requests`
|
|
||||||
К названию эндпоинта добавляется домен итд и `api`, то есть в этом примере отпарвится `https://xn--d1ah4a.com/api/эндпоинт`.
|
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> `xn--d1ah4a.com` - punycode от "итд.com"
|
|
||||||
|
|
||||||
## Прочее
|
|
||||||
Лицезия: [MIT](./LICENSE)
|
|
||||||
Идея (и часть эндпоинтов): https://github.com/FriceKa/ITD-SDK-js
|
|
||||||
- По сути этот проект является реворком, просто на другом языке
|
|
||||||
|
|
||||||
Автор: [itd_sdk](https://xn--d1ah4a.com/itd_sdk) (в итд) [@desicars](https://t.me/desicars) (в тг)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
### Скрипт на обновление имени
|
### Скрипт на обновление имени
|
||||||
```python
|
```python
|
||||||
@@ -76,4 +46,40 @@ id = c.upload_file('любое-имя.png', open('реальное-имя-фай
|
|||||||
c.update_profile(banner_id=id)
|
c.update_profile(banner_id=id)
|
||||||
print('баннер обновлен')
|
print('баннер обновлен')
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Встроенные запросы
|
||||||
|
Существуют встроенные эндпоинты для комментариев, хэштэгов, уведомлений, постов, репортов, поиска, пользователей, итд.
|
||||||
|
```python
|
||||||
|
c.get_user('ITD_API') # получение данных пользователя
|
||||||
|
c.get_me() # получение своих данных (me)
|
||||||
|
c.update_profile(display_name='22:26') # изменение данных профиля, например имя, био итд
|
||||||
|
c.create_post('тест1') # создание постов
|
||||||
|
# итд
|
||||||
|
```
|
||||||
|
|
||||||
|
### Кастомные запросы
|
||||||
|
|
||||||
|
```python
|
||||||
|
from itd.request import fetch
|
||||||
|
|
||||||
|
fetch(c.token, 'метод', 'эндпоинт', {'данные': 'данные'})
|
||||||
|
```
|
||||||
|
Из методов поддерживается `get`, `post`, `put` итд, которые есть в `requests`
|
||||||
|
К названию эндпоинта добавляется домен итд и `api`, то есть в этом примере отпарвится `https://xn--d1ah4a.com/api/эндпоинт`.
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> `xn--d1ah4a.com` - punycode от "итд.com"
|
||||||
|
|
||||||
|
## Планы
|
||||||
|
|
||||||
|
- Добавление ООП (отдеьные классы по типу User или Post вместо обычного JSON)
|
||||||
|
- Голосовые сообщения
|
||||||
|
|
||||||
|
|
||||||
|
## Прочее
|
||||||
|
Лицезия: [MIT](./LICENSE)
|
||||||
|
Идея (и часть эндпоинтов): https://github.com/FriceKa/ITD-SDK-js
|
||||||
|
- По сути этот проект является реворком, просто на другом языке
|
||||||
|
|
||||||
|
Автор: [itd_sdk](https://xn--d1ah4a.com/itd_sdk) (в итд) [@desicars](https://t.me/desicars) (в тг)
|
||||||
|
|||||||
Reference in New Issue
Block a user