Клиент для взаимодействия с сервисом логирования действий пользователя (PGHist).
Project description
Пакет pghist-client
предоставляет клиент для работы с сервисом pgchangehistory
.
Возможности
- Выполнение запросов к сервису логирования с учётом фильтров pgchangehistory.
- Предобработка результатов выполнения запросов.
- Представление результатов в виде dataclass'ов.
- Предоставление провайдера
HistoryDataProvider
для работы с данными.
Системные требования
- Python >=3.6
- Django >=2.2,<5.1
- requests >=2,<3
- requests-oauthlib <=1.3.1
- oauthlib >=2,<3.3
- djangorestframework
Установка и подключение
Установка:
$ pip install pghist-client
Настройка:
INSTALLED_APPS += [
'rest_framework',
'pghist_client',
]
PGHIST = dict(
API_URL='http://pgchangehistory.api.url/',
TIMEOUT=5,
USE_SIMPLE_SERVER=False,
OAUTH2=dict(
ACCESS_TOKEN='token_to_access',
TOKEN_URL='http://pgchangehistory.api.url/oauth2/token/',
CLIENT_ID='client_id',
CLIENT_SECRET='client_secret',
USERNAME='username',
PASSWORD='******',
),
)
Настройки
API_URL
--- URL API сервера pgchangehistory.TIMEOUT
--- timeout запроса к серверу pgchangehistory в секундах.USE_SIMPLE_SERVER
--- Флаг использования сервиса без авторизации (приTrue
потребуется какой-либо дефолтныйACCESS_TOKEN
, имеющийся в сервисе).ACCESS_TOKEN
--- Токен доступа к сервису (требуется только при использовании сервиса без авторизации).OAUTH2
--- Блок параметров для OAUTH2 авторизации (необходимы приUSE_SIMPLE_SERVER=False
):TOKEN_URL
--- URL для получения токена, должен использоваться HTTPS.CLIENT_ID
--- ID клиента, созданный на стороне REST-сервера.CLIENT_SECRET
--- Секретный ключ клиента, созданный на стороне REST-сервера.USERNAME
--- username пользователя для получения токена.PASSWORD
--- password пользователя для получения токена.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pghist_client-0.1.1.tar.gz
(11.0 kB
view hashes)
Built Distribution
Close
Hashes for pghist_client-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c48062679ec425ced65db8962d25ae0c2759d1ac33b30c5df59d79b1aa27bc3 |
|
MD5 | 953e7829481acd9382b425af7c7aae2a |
|
BLAKE2b-256 | 675668e61bceb21b7b5b6e2115c1114865774b5f452c581faed63513077a5bc2 |