nccgest 0.1.0__tar.gz

nccgest-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+.idea/
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+dist/
+build/
+htmlcov/
+data/
+
+# Local/internal materials not for public package
+help/

nccgest-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Oleg Klishin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nccgest-0.1.0/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: nccgest
+Version: 0.1.0
+Summary: Sync and async Python client for NCCGEST REST API.
+Project-URL: Homepage, https://github.com/klishinoleg/nccgest
+Project-URL: Repository, https://github.com/klishinoleg/nccgest
+Project-URL: Issues, https://github.com/klishinoleg/nccgest/issues
+Author: Oleg Klishin
+License: MIT
+License-File: LICENSE
+Keywords: api,booking,nccgest,rest,transport
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: httpx<1,>=0.27
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == 'dev'
+Requires-Dist: fastapi<1,>=0.115; extra == 'dev'
+Requires-Dist: itsdangerous<3,>=2.2; extra == 'dev'
+Requires-Dist: jinja2<4,>=3.1; extra == 'dev'
+Requires-Dist: mypy>=1.14.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.0; extra == 'dev'
+Requires-Dist: python-multipart>=0.0.9; extra == 'dev'
+Requires-Dist: pyyaml<7,>=6.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Requires-Dist: twine>=6.0.0; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0.12; extra == 'dev'
+Requires-Dist: uvicorn<1,>=0.35; extra == 'dev'
+Provides-Extra: mock
+Requires-Dist: fastapi<1,>=0.115; extra == 'mock'
+Requires-Dist: itsdangerous<3,>=2.2; extra == 'mock'
+Requires-Dist: jinja2<4,>=3.1; extra == 'mock'
+Requires-Dist: python-multipart>=0.0.9; extra == 'mock'
+Requires-Dist: pyyaml<7,>=6.0; extra == 'mock'
+Requires-Dist: uvicorn<1,>=0.35; extra == 'mock'
+Description-Content-Type: text/markdown
+
+# nccgest
+
+[English](README.md) | [Italiano](README.it.md) | [Русский](README.ru.md)
+
+Python package for synchronous and asynchronous interaction with the NCCGEST REST API.
+
+Full method-by-method documentation:
+
+- [docs/library_api.ru.md](C:/python/pip/nccgest/docs/library_api.ru.md) (RU)
+
+## Features
+
+- Sync client: `NCCGestClient`
+- Async client: `AsyncNCCGestClient`
+- Command coverage:
+  - `cmd_read`
+  - `cmd_insert`
+  - `cmd_update`
+  - `cmd_customer`
+  - `cmd_driver`
+- Typed API errors and HTTP errors
+- Python `3.8+` support (recommended runtime: `3.10+`)
+
+## Installation
+
+```bash
+pip install nccgest
+```
+
+## Quick Start (sync)
+
+```python
+from nccgest import NCCGestClient
+
+with NCCGestClient(domain="your-domain", token="YOUR_TOKEN") as client:
+    services = client.read_services(start_date="16/03/2026", end_date="16/03/2026")
+    print(services)
+```
+
+## Quick Start (async)
+
+```python
+import asyncio
+from nccgest import AsyncNCCGestClient
+
+async def main() -> None:
+    async with AsyncNCCGestClient(domain="your-domain", token="YOUR_TOKEN") as client:
+        driver_data = await client.get_driver_data(driverid=123)
+        print(driver_data)
+
+asyncio.run(main())
+```
+
+## Insert Service Example
+
+```python
+from nccgest import NCCGestClient
+
+payload = {
+    "pickup": "FCO",
+    "dropoff": "Roma",
+    "date": "16/03/2026",
+    "pickup_time": "10:30",
+    "pax": 2,
+    "paxname": "John Smith",
+    "paxphone": "+39000000000",
+    "servicetype": "Transfer",
+    "cartype": "Business Class",
+    "subclass": "EXT-ORDER-12345",
+}
+
+with NCCGestClient(domain="your-domain", token="YOUR_TOKEN") as client:
+    service_id = client.insert_service(payload)
+    print(service_id)
+```
+
+## API Notes
+
+- Use HTTPS only.
+- NCCGEST API docs mention no concurrent inserts: avoid parallel create calls.
+- Use proper URL encoding for external inputs.
+- Follow official endpoint method mapping (`GET` for read/customer/driver, `POST` for insert/update).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+## Mock Service (FastAPI + SQLite)
+
+Install mock dependencies:
+
+```bash
+pip install -e ".[mock]"
+```
+
+Run:
+
+```bash
+NCCGEST_LOGIN=test NCCGEST_PASSWORD=test NCCGEST_DBDIR=/data NCCGEST_PORT=8255 python -m nccgest.mock_service
+```
+
+Alternative command:
+
+```bash
+nccgest-mock
+```
+
+Web UI:
+
+- Login page: `http://localhost:8255/admin/login`
+- Services admin: `http://localhost:8255/admin/services`
+- Drivers admin: `http://localhost:8255/admin/drivers`
+- API endpoint: `http://localhost:8255/api/rest_api.php`
+
+The `/data` directory is ignored by git and used for the local SQLite DB.
+Mock YAML fixtures for tests are stored in `tests/mock_data/services.yaml`.
+UI templates and CSS are separated in:
+
+- `src/nccgest/mock_service/templates/*.html`
+- `src/nccgest/mock_service/static/style.css`

nccgest-0.1.0/README.it.md

@@ -0,0 +1,87 @@
+# nccgest
+
+[English](README.md) | [Italiano](README.it.md) | [Русский](README.ru.md)
+
+Pacchetto Python per integrare in modo sincrono e asincrono la REST API di NCCGEST.
+
+## Funzionalita
+
+- Client sincrono: `NCCGestClient`
+- Client asincrono: `AsyncNCCGestClient`
+- Comandi supportati:
+  - `cmd_read`
+  - `cmd_insert`
+  - `cmd_update`
+  - `cmd_customer`
+  - `cmd_driver`
+- Errori API e HTTP tipizzati
+- Supporto Python `3.8+` (runtime consigliato: `3.10+`)
+
+## Installazione
+
+```bash
+pip install nccgest
+```
+
+## Esempio rapido (sync)
+
+```python
+from nccgest import NCCGestClient
+
+with NCCGestClient(domain="your-domain", token="YOUR_TOKEN") as client:
+    services = client.read_services(start_date="16/03/2026", end_date="16/03/2026")
+    print(services)
+```
+
+## Esempio rapido (async)
+
+```python
+import asyncio
+from nccgest import AsyncNCCGestClient
+
+async def main() -> None:
+    async with AsyncNCCGestClient(domain="your-domain", token="YOUR_TOKEN") as client:
+        driver_data = await client.get_driver_data(driverid=123)
+        print(driver_data)
+
+asyncio.run(main())
+```
+
+## Note API
+
+- Usare solo HTTPS.
+- Evitare inserimenti concorrenti in parallelo.
+- Codificare correttamente i parametri (URL encoding).
+- Rispettare i metodi endpoint della documentazione (`GET` per read/customer/driver, `POST` per insert/update).
+
+## Servizio Mock (FastAPI + SQLite)
+
+Installazione dipendenze:
+
+```bash
+pip install -e ".[mock]"
+```
+
+Avvio:
+
+```bash
+NCCGEST_LOGIN=test NCCGEST_PASSWORD=test NCCGEST_DBDIR=/data NCCGEST_PORT=8255 python -m nccgest.mock_service
+```
+
+Comando alternativo:
+
+```bash
+nccgest-mock
+```
+
+- Web UI (login/lista/modifica): `http://localhost:8255/admin/login`
+- Servizi admin: `http://localhost:8255/admin/services`
+- Driver admin: `http://localhost:8255/admin/drivers`
+- API endpoint: `http://localhost:8255/api/rest_api.php`
+
+La cartella `/data` e ignorata da git e contiene il DB SQLite locale.
+I fixture YAML per i test sono in `tests/mock_data/services.yaml`.
+Template e CSS separati:
+
+- `src/nccgest/mock_service/templates/*.html`
+- `src/nccgest/mock_service/static/style.css`

nccgest-0.1.0/README.md

@@ -0,0 +1,123 @@
+# nccgest
+
+[English](README.md) | [Italiano](README.it.md) | [Русский](README.ru.md)
+
+Python package for synchronous and asynchronous interaction with the NCCGEST REST API.
+
+Full method-by-method documentation:
+
+- [docs/library_api.ru.md](C:/python/pip/nccgest/docs/library_api.ru.md) (RU)
+
+## Features
+
+- Sync client: `NCCGestClient`
+- Async client: `AsyncNCCGestClient`
+- Command coverage:
+  - `cmd_read`
+  - `cmd_insert`
+  - `cmd_update`
+  - `cmd_customer`
+  - `cmd_driver`
+- Typed API errors and HTTP errors
+- Python `3.8+` support (recommended runtime: `3.10+`)
+
+## Installation
+
+```bash
+pip install nccgest
+```
+
+## Quick Start (sync)
+
+```python
+from nccgest import NCCGestClient
+
+with NCCGestClient(domain="your-domain", token="YOUR_TOKEN") as client:
+    services = client.read_services(start_date="16/03/2026", end_date="16/03/2026")
+    print(services)
+```
+
+## Quick Start (async)
+
+```python
+import asyncio
+from nccgest import AsyncNCCGestClient
+
+async def main() -> None:
+    async with AsyncNCCGestClient(domain="your-domain", token="YOUR_TOKEN") as client:
+        driver_data = await client.get_driver_data(driverid=123)
+        print(driver_data)
+
+asyncio.run(main())
+```
+
+## Insert Service Example
+
+```python
+from nccgest import NCCGestClient
+
+payload = {
+    "pickup": "FCO",
+    "dropoff": "Roma",
+    "date": "16/03/2026",
+    "pickup_time": "10:30",
+    "pax": 2,
+    "paxname": "John Smith",
+    "paxphone": "+39000000000",
+    "servicetype": "Transfer",
+    "cartype": "Business Class",
+    "subclass": "EXT-ORDER-12345",
+}
+
+with NCCGestClient(domain="your-domain", token="YOUR_TOKEN") as client:
+    service_id = client.insert_service(payload)
+    print(service_id)
+```
+
+## API Notes
+
+- Use HTTPS only.
+- NCCGEST API docs mention no concurrent inserts: avoid parallel create calls.
+- Use proper URL encoding for external inputs.
+- Follow official endpoint method mapping (`GET` for read/customer/driver, `POST` for insert/update).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+## Mock Service (FastAPI + SQLite)
+
+Install mock dependencies:
+
+```bash
+pip install -e ".[mock]"
+```
+
+Run:
+
+```bash
+NCCGEST_LOGIN=test NCCGEST_PASSWORD=test NCCGEST_DBDIR=/data NCCGEST_PORT=8255 python -m nccgest.mock_service
+```
+
+Alternative command:
+
+```bash
+nccgest-mock
+```
+
+Web UI:
+
+- Login page: `http://localhost:8255/admin/login`
+- Services admin: `http://localhost:8255/admin/services`
+- Drivers admin: `http://localhost:8255/admin/drivers`
+- API endpoint: `http://localhost:8255/api/rest_api.php`
+
+The `/data` directory is ignored by git and used for the local SQLite DB.
+Mock YAML fixtures for tests are stored in `tests/mock_data/services.yaml`.
+UI templates and CSS are separated in:
+
+- `src/nccgest/mock_service/templates/*.html`
+- `src/nccgest/mock_service/static/style.css`

nccgest-0.1.0/README.ru.md

@@ -0,0 +1,91 @@
+# nccgest
+
+[English](README.md) | [Italiano](README.it.md) | [Русский](README.ru.md)
+
+Python-библиотека для синхронной и асинхронной интеграции с REST API NCCGEST.
+
+Полная инструкция по API библиотеки:
+
+- [docs/library_api.ru.md](C:/python/pip/nccgest/docs/library_api.ru.md)
+
+## Возможности
+
+- Синхронный клиент: `NCCGestClient`
+- Асинхронный клиент: `AsyncNCCGestClient`
+- Поддерживаемые команды:
+  - `cmd_read`
+  - `cmd_insert`
+  - `cmd_update`
+  - `cmd_customer`
+  - `cmd_driver`
+- Типизированные ошибки API и HTTP
+- Поддержка Python `3.8+` (рекомендуемый runtime: `3.10+`)
+
+## Установка
+
+```bash
+pip install nccgest
+```
+
+## Быстрый старт (sync)
+
+```python
+from nccgest import NCCGestClient
+
+with NCCGestClient(domain="your-domain", token="YOUR_TOKEN") as client:
+    services = client.read_services(start_date="16/03/2026", end_date="16/03/2026")
+    print(services)
+```
+
+## Быстрый старт (async)
+
+```python
+import asyncio
+from nccgest import AsyncNCCGestClient
+
+async def main() -> None:
+    async with AsyncNCCGestClient(domain="your-domain", token="YOUR_TOKEN") as client:
+        driver_data = await client.get_driver_data(driverid=123)
+        print(driver_data)
+
+asyncio.run(main())
+```
+
+## Примечания по API
+
+- Использовать только HTTPS.
+- Не отправлять вставки услуг параллельно.
+- Выполнять URL encoding входных параметров.
+- Соблюдать методы endpoint-ов из документации (`GET` для read/customer/driver, `POST` для insert/update).
+
+## Mock-сервис (FastAPI + SQLite)
+
+Установка зависимостей:
+
+```bash
+pip install -e ".[mock]"
+```
+
+Запуск:
+
+```bash
+NCCGEST_LOGIN=test NCCGEST_PASSWORD=test NCCGEST_DBDIR=/data NCCGEST_PORT=8255 python -m nccgest.mock_service
+```
+
+Или командой:
+
+```bash
+nccgest-mock
+```
+
+- Web UI (логин/списки/редактирование): `http://localhost:8255/admin/login`
+- Услуги (админка): `http://localhost:8255/admin/services`
+- Водители (админка): `http://localhost:8255/admin/drivers`
+- API endpoint: `http://localhost:8255/api/rest_api.php`
+
+Каталог `/data` исключен из git и используется для локальной SQLite базы.
+Mock-фикстуры для автотестов лежат в `tests/mock_data/services.yaml`.
+Шаблоны и стили вынесены отдельно:
+
+- `src/nccgest/mock_service/templates/*.html`
+- `src/nccgest/mock_service/static/style.css`