amocrm-api-wrapper 0.0.20__tar.gz → 1.0.1__tar.gz

amocrm_api_wrapper-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 bzdvdn
+
+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.

amocrm_api_wrapper-1.0.1/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: amocrm-api-wrapper
+Version: 1.0.1
+Summary: AmoCRM v4 REST API wrapper with sync and async clients
+Author-email: bzdvdn <bzdv.dn@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/bzdvdn/amocrm-api-wrapper
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.25
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: readme-renderer>=35.0; extra == "dev"
+Requires-Dist: twine>=5.1; extra == "dev"
+Dynamic: license-file
+
+# wrapper for amocrm rest api
+
+## Install
+
+Install using `pip`...
+
+    pip install amocrm-api-wrapper
+
+## Async support
+
+Every method has an async twin with the `_async` suffix (e.g. `get_leads_async`).
+Async variants use `httpx.AsyncClient` natively and return awaitables:
+
+```python
+import asyncio
+from amocrm_api import AmoOAuthClient
+
+async def main():
+    client = AmoOAuthClient('<access_token>', '<refresh_token>', '<crm_url>', '<client_id>', '<client_secret>', '<redirect_uri>')
+    leads = await client.get_leads_async()
+    print(leads)
+    await client.close_async()
+
+asyncio.run(main())
+```
+
+For the legacy client the async session is initialized lazily on the first
+async call, no extra setup is required:
+
+```python
+import asyncio
+from amocrm_api import AmoLegacyClient
+
+async def main():
+    client = AmoLegacyClient('<login>', '<token>', '<crm_url>')
+    users = await client.get_users_async()
+    print(users)
+
+asyncio.run(main())
+```
+
+## Pagination
+
+Methods that return collections across pages (`iter_*`) fetch all pages
+lazily, so you don't have to manage `page`/`limit` manually. Sync variants
+are generators, async variants are async generators:
+
+```python
+# sync
+for lead in client.iter_leads(filters={"name": "x"}):
+    print(lead["id"])
+
+# async
+async for contact in client.iter_contacts_async():
+    print(contact["id"])
+```
+
+Available iterators:
+
+| Method | Async twin | Notes |
+| :--- | :--- | :--- |
+| `iter_leads` | `iter_leads_async` | |
+| `iter_contacts` | `iter_contacts_async` | |
+| `iter_companies` | `iter_companies_async` | |
+| `iter_tasks` | `iter_tasks_async` | |
+| `iter_catalog_elements(catalog_id, ...)` | `iter_catalog_elements_async` | |
+| `iter_tags_by_entity_type(entity_type, ...)` | `iter_tags_by_entity_type_async` | |
+
+All accept the same filters/order/with-params as the corresponding `get_*`
+methods, but the `page` argument is handled for you.
+
+## Usage
+
+```python
+from amocrm_api import AmoLegacyClient # for login password auth
+from amocrm_api import AmoOAuthClient # for oauth
+from datetime import datetime
+
+client = AmoLegacyClient('<login>', '<password>', '<crm_url>')
+client = AmoOAuthClient('<access_token>', '<refresh_token>', '<crm_url>', '<client_id>', '<client_secret>', '<redirect_uri>')
+dt = datetime.datetime.today().strftime("%a, %d %b %Y %H-%m-%d")
+date_time = f"{dt} UTC"
+
+# for Legacy client
+headers = {
+    "IF-MODIFIED-SINCE": f"{date_time}",
+    "Content-Type": "application/json",
+}
+
+client.update_session_params(headers)
+```
+
+## Documentation
+
+Per-entity API reference is split into `docs/`. Every method has an async
+twin with the `_async` suffix; each file ends with an async usage example:
+
+| Entity | File |
+| :--- | :--- |
+| Account | [docs/account.md](docs/account.md) |
+| Leads | [docs/leads.md](docs/leads.md) |
+| Unsorted leads | [docs/unsorted.md](docs/unsorted.md) |
+| Pipelines | [docs/pipelines.md](docs/pipelines.md) |
+| Contacts | [docs/contacts.md](docs/contacts.md) |
+| Companies | [docs/companies.md](docs/companies.md) |
+| Customers | [docs/customers.md](docs/customers.md) |
+| Catalogs | [docs/catalogs.md](docs/catalogs.md) |
+| Tasks | [docs/tasks.md](docs/tasks.md) |
+| Notes | [docs/notes.md](docs/notes.md) |
+| Events | [docs/events.md](docs/events.md) |
+| Tags | [docs/tags.md](docs/tags.md) |
+| Loss reasons | [docs/loss_reasons.md](docs/loss_reasons.md) |
+| Sources | [docs/sources.md](docs/sources.md) |
+| Chats | [docs/chats.md](docs/chats.md) |
+| Users | [docs/users.md](docs/users.md) |
+| Webhooks | [docs/webhooks.md](docs/webhooks.md) |
+| Widgets | [docs/widgets.md](docs/widgets.md) |
+| Custom fields | [docs/custom_fields.md](docs/custom_fields.md) |
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.

amocrm_api_wrapper-1.0.1/README.md

@@ -0,0 +1,120 @@
+# wrapper for amocrm rest api
+
+## Install
+
+Install using `pip`...
+
+    pip install amocrm-api-wrapper
+
+## Async support
+
+Every method has an async twin with the `_async` suffix (e.g. `get_leads_async`).
+Async variants use `httpx.AsyncClient` natively and return awaitables:
+
+```python
+import asyncio
+from amocrm_api import AmoOAuthClient
+
+async def main():
+    client = AmoOAuthClient('<access_token>', '<refresh_token>', '<crm_url>', '<client_id>', '<client_secret>', '<redirect_uri>')
+    leads = await client.get_leads_async()
+    print(leads)
+    await client.close_async()
+
+asyncio.run(main())
+```
+
+For the legacy client the async session is initialized lazily on the first
+async call, no extra setup is required:
+
+```python
+import asyncio
+from amocrm_api import AmoLegacyClient
+
+async def main():
+    client = AmoLegacyClient('<login>', '<token>', '<crm_url>')
+    users = await client.get_users_async()
+    print(users)
+
+asyncio.run(main())
+```
+
+## Pagination
+
+Methods that return collections across pages (`iter_*`) fetch all pages
+lazily, so you don't have to manage `page`/`limit` manually. Sync variants
+are generators, async variants are async generators:
+
+```python
+# sync
+for lead in client.iter_leads(filters={"name": "x"}):
+    print(lead["id"])
+
+# async
+async for contact in client.iter_contacts_async():
+    print(contact["id"])
+```
+
+Available iterators:
+
+| Method | Async twin | Notes |
+| :--- | :--- | :--- |
+| `iter_leads` | `iter_leads_async` | |
+| `iter_contacts` | `iter_contacts_async` | |
+| `iter_companies` | `iter_companies_async` | |
+| `iter_tasks` | `iter_tasks_async` | |
+| `iter_catalog_elements(catalog_id, ...)` | `iter_catalog_elements_async` | |
+| `iter_tags_by_entity_type(entity_type, ...)` | `iter_tags_by_entity_type_async` | |
+
+All accept the same filters/order/with-params as the corresponding `get_*`
+methods, but the `page` argument is handled for you.
+
+## Usage
+
+```python
+from amocrm_api import AmoLegacyClient # for login password auth
+from amocrm_api import AmoOAuthClient # for oauth
+from datetime import datetime
+
+client = AmoLegacyClient('<login>', '<password>', '<crm_url>')
+client = AmoOAuthClient('<access_token>', '<refresh_token>', '<crm_url>', '<client_id>', '<client_secret>', '<redirect_uri>')
+dt = datetime.datetime.today().strftime("%a, %d %b %Y %H-%m-%d")
+date_time = f"{dt} UTC"
+
+# for Legacy client
+headers = {
+    "IF-MODIFIED-SINCE": f"{date_time}",
+    "Content-Type": "application/json",
+}
+
+client.update_session_params(headers)
+```
+
+## Documentation
+
+Per-entity API reference is split into `docs/`. Every method has an async
+twin with the `_async` suffix; each file ends with an async usage example:
+
+| Entity | File |
+| :--- | :--- |
+| Account | [docs/account.md](docs/account.md) |
+| Leads | [docs/leads.md](docs/leads.md) |
+| Unsorted leads | [docs/unsorted.md](docs/unsorted.md) |
+| Pipelines | [docs/pipelines.md](docs/pipelines.md) |
+| Contacts | [docs/contacts.md](docs/contacts.md) |
+| Companies | [docs/companies.md](docs/companies.md) |
+| Customers | [docs/customers.md](docs/customers.md) |
+| Catalogs | [docs/catalogs.md](docs/catalogs.md) |
+| Tasks | [docs/tasks.md](docs/tasks.md) |
+| Notes | [docs/notes.md](docs/notes.md) |
+| Events | [docs/events.md](docs/events.md) |
+| Tags | [docs/tags.md](docs/tags.md) |
+| Loss reasons | [docs/loss_reasons.md](docs/loss_reasons.md) |
+| Sources | [docs/sources.md](docs/sources.md) |
+| Chats | [docs/chats.md](docs/chats.md) |
+| Users | [docs/users.md](docs/users.md) |
+| Webhooks | [docs/webhooks.md](docs/webhooks.md) |
+| Widgets | [docs/widgets.md](docs/widgets.md) |
+| Custom fields | [docs/custom_fields.md](docs/custom_fields.md) |
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.

amocrm_api_wrapper-1.0.1/amocrm_api/__init__.py

@@ -0,0 +1,11 @@
+from .legacy_client import AmoLegacyClient as AmoLegacyClient
+from .oauth_client import AmoOAuthClient as AmoOAuthClient
+
+__all__ = [
+    "AmoLegacyClient",
+    "AmoOAuthClient",
+    "__version__",
+]
+
+__version__ = "1.0.1"
+__author__ = "bzdvdn"

amocrm_api_wrapper-1.0.1/amocrm_api/base.py

@@ -0,0 +1,56 @@
+from .entities import (
+    Calls,
+    Catalogs,
+    Chats,
+    ChatTemplates,
+    Companies,
+    Contacts,
+    Customers,
+    CustomerStatuses,
+    CustomFields,
+    Events,
+    Leads,
+    LossReasons,
+    Notes,
+    Pipelines,
+    ShortLinks,
+    Sources,
+    Subscriptions,
+    Tags,
+    Talks,
+    Tasks,
+    Unsorted,
+    Users,
+    Webhooks,
+    Widgets,
+)
+from .entities.base import mask_token as mask_token  # noqa: PLC0414 (re-export)
+
+
+class BaseClient(
+    Leads,
+    Unsorted,
+    Pipelines,
+    Contacts,
+    Companies,
+    Customers,
+    Catalogs,
+    CustomFields,
+    CustomerStatuses,
+    Users,
+    Webhooks,
+    Widgets,
+    Tasks,
+    Tags,
+    Events,
+    Notes,
+    LossReasons,
+    Sources,
+    Talks,
+    Subscriptions,
+    Calls,
+    ChatTemplates,
+    ShortLinks,
+    Chats,
+):
+    """Aggregates all amocrm entities into a single client interface."""

amocrm_api_wrapper-1.0.1/amocrm_api/entities/__init__.py

@@ -0,0 +1,53 @@
+from .base import Entity
+from .calls import Calls
+from .catalogs import Catalogs
+from .chat_templates import ChatTemplates
+from .chats import Chats
+from .companies import Companies
+from .contacts import Contacts
+from .custom_fields import CustomFields
+from .customer_statuses import CustomerStatuses
+from .customers import Customers
+from .events import Events
+from .leads import Leads
+from .loss_reasons import LossReasons
+from .notes import Notes
+from .pipelines import Pipelines
+from .short_links import ShortLinks
+from .sources import Sources
+from .subscriptions import Subscriptions
+from .tags import Tags
+from .talks import Talks
+from .tasks import Tasks
+from .unsorted import Unsorted
+from .users import Users
+from .webhooks import Webhooks
+from .widgets import Widgets
+
+__all__ = [
+    "Calls",
+    "Catalogs",
+    "ChatTemplates",
+    "Chats",
+    "Companies",
+    "Contacts",
+    "CustomFields",
+    "CustomerStatuses",
+    "Customers",
+    "Entity",
+    "Events",
+    "Leads",
+    "LossReasons",
+    "Notes",
+    "Pipelines",
+    "ShortLinks",
+    "Sources",
+    "Subscriptions",
+    "Tags",
+    "Talks",
+    "Tasks",
+    "Unsorted",
+    "Users",
+    "Webhooks",
+    "Widgets"
+]