docs: add docs; relase to pypi
This commit is contained in:
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,3 +1,5 @@
|
||||
test.py
|
||||
venv/
|
||||
__pycache__/
|
||||
__pycache__/
|
||||
dist
|
||||
itd_sdk.egg-info
|
||||
50
README.md
50
README.md
@@ -1,2 +1,50 @@
|
||||
# pyITDclient
|
||||
ITD client for python
|
||||
Клиент ITD для python
|
||||
|
||||
|
||||
## Установка
|
||||
|
||||
```bash
|
||||
pip install pyITDclient
|
||||
```
|
||||
|
||||
## Пример
|
||||
|
||||
```python
|
||||
from itd import ITDClient
|
||||
|
||||
c = ITDClient('TOKEN', 'refresh_token=...; __ddg1_=...; __ddgid_=...; is_auth=1; __ddg2_=...; ddg_last_challenge=...; __ddg8_=...; __ddg10_=...; __ddg9_=...')
|
||||
# можно указать только токен, тогда после просрочки перестанет работать, либо только куки чтобы токен сразу подтянулся, либо оба сразу
|
||||
|
||||
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/эндпоинт`.
|
||||
|
||||
> ![INFO]
|
||||
> `xn--d1ah4a.com` - punycode от "итд.com"
|
||||
|
||||
## прочее
|
||||
Лицезия: [MIT](./LICENSE)
|
||||
Идея (и часть эндпоинтов): https://github.com/FriceKa/ITD-SDK-js
|
||||
- По сути этот проект является реворком, просто на другом языке
|
||||
|
||||
Автор: [SizedBox](https://xn--d1ah4a.com/SizedBox) (в итд) [@desicars](https://t.me/desicars) (в тг)
|
||||
17
pyproject.toml
Normal file
17
pyproject.toml
Normal file
@@ -0,0 +1,17 @@
|
||||
[build-system]
|
||||
requires = ["setuptools", "wheel"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "itd-sdk"
|
||||
version = "0.1.0"
|
||||
description = "ITD client for python"
|
||||
readme = "README.md"
|
||||
authors = [
|
||||
{ name = "firedotguy", email = "nta16022013@gmail.com" }
|
||||
]
|
||||
license = "MIT"
|
||||
dependencies = [
|
||||
"requests"
|
||||
]
|
||||
requires-python = ">=3.9"
|
||||
Reference in New Issue
Block a user