Metadata-Version: 2.1
Name: ord_mediascout_client
Version: 0.0.4
Summary: API Client for Mediascout ORD
Project-URL: Homepage, https://github.com/KokocGroup/OrdMediascoutClientAPI
Project-URL: Bug Tracker, https://github.com/KokocGroup/OrdMediascoutClientAPI/issues
Author-email: Alexey Ruzin <ruzin@me.com>, Ilya Chegodayev <lighter97@gmail.com>
License-File: LICENSE.txt
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Requires-Dist: pydantic==1.10.7
Requires-Dist: python-dotenv==1.0.0
Requires-Dist: requests==2.28.2
Description-Content-Type: text/markdown

# Mediascout ORD API client

Unofficial python client for [ORD Mediascout API](https://demo.mediascout.ru/swagger/index.html).

## Installation

    pip install ord-mediascout-client

## Usage

    from ord_mediascout_client import ORDMediascoutClient, \
        ORDMediascoutConfig, CreateClientWebApiDto, \
        ClientRelationshipType, LegalForm
    from ord_mediascout_client.client import APIError

    config = ORDMediascoutConfig(
        url='http://localhost:5000',
        username='username',
        password='password',
    )

    api = ORDMediascoutClient(config)

    client = CreateClientWebApiDto(
        createMode=ClientRelationshipType.DirectClient,
        legalForm=LegalForm.JuridicalPerson,
        inn="1234567890",
        name="Test Client",
        mobilePhone="1234567890",
        epayNumber=None,
        regNumber=None,
        oksmNumber=None
    )

    client = api.create_client(client)


## Testing

    pipenv install --dev
    pipenv shell

    # get credentials for accessing https://demo.mediascout.ru/
    # and put them into .env file (see .env.example.env)

    pytest


## Packaging

    pipenv install --dev
    pipenv shell

    vi pyproject.toml # update version

    python -m build
    python -m twine upload dist/*
