tmforum 0.1.0__tar.gz

tmforum-0.1.0/.gitignore

@@ -0,0 +1,229 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# OS generated files #
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+# Claude Code local settings
+.claude/

tmforum-0.1.0/LICENSE

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

tmforum-0.1.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: tmforum
+Version: 0.1.0
+Summary: Unofficial Python SDK for TM Forum Open APIs: dataclass entity models with @type-aware serialization and REST CRUD helpers
+Project-URL: Homepage, https://github.com/alex-chadyuk/tmforum
+Project-URL: Issues, https://github.com/alex-chadyuk/tmforum/issues
+Author-email: Alex Chadyuk <alex@chady.uk>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bss,oda,open-api,product-catalog,product-ordering,telecom,tmf,tmforum
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.25
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# tmforum
+
+Unofficial Python SDK for [TM Forum Open APIs](https://www.tmforum.org/oda/open-apis/) — plain-dataclass entity models, `@type`-aware (de)serialization, and thin REST CRUD helpers.
+
+- **No heavy dependencies** — just `requests`. Entities are standard-library `dataclasses`, not pydantic models.
+- **Polymorphism-aware serialization** — `from_dict` resolves `@type` / `@referredType` discriminators to the right Python class; `to_dict` emits them back, so round-tripping TMF payloads preserves their type structure.
+- **Thin CRUD layer** — `create` / `read` / `update` / `delete` / `query_get` methods that map 1:1 onto the TMF REST conventions. No hidden state, no client object: a small `Context` carries the base URL, auth, and headers.
+
+## Install
+
+```bash
+pip install tmforum
+```
+
+Python 3.9+.
+
+## Quickstart
+
+```python
+from tmforum import Context, Individual, ProductOffering
+
+context = Context(
+    api_base_url="https://api.example.com/tmf-api",
+    access_token="...",
+    currency_code="USD",
+)
+context.headers = {
+    "Content-Type": "application/json",
+    "Accept": "application/json",
+    "Authorization": f"Bearer {context.access_token}",
+}
+
+# Create, read, query, delete — TMF632 Party Management
+person = Individual(givenName="Jane", familyName="Doe")
+person = person.create(context)     # POST /partyManagement/v5/individual
+person = person.read(context)       # GET  /partyManagement/v5/individual/{id}
+
+# TMF620 Product Catalog
+offers = ProductOffering.query_get("lifecycleStatus=Active", context)
+
+person.delete(context)              # DELETE /partyManagement/v5/individual/{id}
+```
+
+Serialization works without a server:
+
+```python
+from tmforum import Product
+
+product = Product.from_dict({
+    "@type": "Product",
+    "id": "42",
+    "name": "Fibre 500",
+    "status": "active",
+    "billingAccount": {"@type": "BillingAccountRef", "id": "ba-1"},
+    "isBundle": False,
+    "quantity": 1,
+    "productPrice": [],
+})
+assert product.billingAccount.id == "ba-1"
+payload = product.to_dict()         # emits @type discriminators back
+```
+
+## Supported TM Forum APIs
+
+The SDK targets the **v5** payload shapes of the Open APIs.
+
+| TMF API | Resource path | Main SDK classes |
+|---|---|---|
+| TMF620 Product Catalog | `productCatalogManagement/v5` | `ProductCatalog`, `Category`, `ProductOffering`, `ProductSpecification` |
+| TMF622 Product Ordering | `productOrdering/v5` | `ProductOrder` |
+| TMF637 Product Inventory | `productInventory/v5` | `Product` |
+| TMF632 Party Management | `partyManagement/v5` | `Individual`, `Organization` |
+| TMF669 Party Role | `partyRoleManagement/v5` | `PartyRole` |
+| TMF666 Account Management | `accountManagement/v5` | `BillingAccount`, `FinancialAccount`, `BillingCycleSpecification` |
+| TMF678 Customer Bill | `customerBill/v5` | `AppliedCustomerBillingRate` |
+| TMF648 Quote | `quoteManagement/v5` | `Quote` |
+| TMF679 Product Offering Qualification | `productOfferingQualification/v5` | `CheckProductOfferingQualification`, `QueryProductOfferingQualification` |
+| TMF699 Sales Management | `salesManagement/v4` | `SalesLead` |
+| TMF723 Policy Management | `policyManagement/v5` | `PolicyDomain`, `ManagedPolicy`, `ManagedPolicyVariable`, `PolicyCatalog` |
+| TMF638 Service Inventory | `serviceInventory/v5` | `Service` |
+| TMF639 Resource Inventory | `resourceInventory/v5` | `Resource` |
+| TMF634 Resource Catalog | `resourceCatalog/v5` | `ResourceSpecification` |
+| TMF685 Resource Pool | `resourcePool/v5` | `ResourcePool`, `ResourcePoolSpecification`, `CapacitySpecification` |
+| TMF676 Payment | `payment/v4` | `PaymentPlan` |
+| TMF760 Product Configuration | *(entity models only)* | `CheckProductConfiguration.from_order()` |
+
+## How it works
+
+Every entity is a `@dataclass` inheriting from `Entity`, which provides recursive `from_dict` / `to_dict` / `to_json`. Type resolution uses each field's type hints plus the payload's `@type` discriminator, so nested and polymorphic structures (e.g. `RelatedPartyRefOrPartyRoleRef`, price alterations, characteristic subtypes) deserialize into the correct classes.
+
+Entities that map to REST resources also inherit `BaseCRUDMixin`, which implements `from_id`, `create`, `read`, `update` (JSON PATCH semantics), `query_get`, and `delete` against `{context.api_base_url}/{resource_path}`. A `Context` dataclass carries `api_base_url`, `access_token`, `headers`, an optional logger, and OAuth-related fields — pass it to every call; there is no global state.
+
+## Status
+
+Alpha. The entity models and serialization are exercised by a pure-offline test suite; the CRUD layer follows the TMF REST conventions, but server implementations vary in the extensions and versions they accept. Issues and PRs welcome.
+
+## License & trademark notice
+
+MIT — see [LICENSE](LICENSE).
+
+This is an **unofficial, community project**. TM Forum® and the TMF API names are trademarks of TM Forum. This project is not affiliated with, endorsed, or sponsored by TM Forum. The Open API specifications referenced are © TM Forum.

tmforum-0.1.0/README.md

@@ -0,0 +1,101 @@
+# tmforum
+
+Unofficial Python SDK for [TM Forum Open APIs](https://www.tmforum.org/oda/open-apis/) — plain-dataclass entity models, `@type`-aware (de)serialization, and thin REST CRUD helpers.
+
+- **No heavy dependencies** — just `requests`. Entities are standard-library `dataclasses`, not pydantic models.
+- **Polymorphism-aware serialization** — `from_dict` resolves `@type` / `@referredType` discriminators to the right Python class; `to_dict` emits them back, so round-tripping TMF payloads preserves their type structure.
+- **Thin CRUD layer** — `create` / `read` / `update` / `delete` / `query_get` methods that map 1:1 onto the TMF REST conventions. No hidden state, no client object: a small `Context` carries the base URL, auth, and headers.
+
+## Install
+
+```bash
+pip install tmforum
+```
+
+Python 3.9+.
+
+## Quickstart
+
+```python
+from tmforum import Context, Individual, ProductOffering
+
+context = Context(
+    api_base_url="https://api.example.com/tmf-api",
+    access_token="...",
+    currency_code="USD",
+)
+context.headers = {
+    "Content-Type": "application/json",
+    "Accept": "application/json",
+    "Authorization": f"Bearer {context.access_token}",
+}
+
+# Create, read, query, delete — TMF632 Party Management
+person = Individual(givenName="Jane", familyName="Doe")
+person = person.create(context)     # POST /partyManagement/v5/individual
+person = person.read(context)       # GET  /partyManagement/v5/individual/{id}
+
+# TMF620 Product Catalog
+offers = ProductOffering.query_get("lifecycleStatus=Active", context)
+
+person.delete(context)              # DELETE /partyManagement/v5/individual/{id}
+```
+
+Serialization works without a server:
+
+```python
+from tmforum import Product
+
+product = Product.from_dict({
+    "@type": "Product",
+    "id": "42",
+    "name": "Fibre 500",
+    "status": "active",
+    "billingAccount": {"@type": "BillingAccountRef", "id": "ba-1"},
+    "isBundle": False,
+    "quantity": 1,
+    "productPrice": [],
+})
+assert product.billingAccount.id == "ba-1"
+payload = product.to_dict()         # emits @type discriminators back
+```
+
+## Supported TM Forum APIs
+
+The SDK targets the **v5** payload shapes of the Open APIs.
+
+| TMF API | Resource path | Main SDK classes |
+|---|---|---|
+| TMF620 Product Catalog | `productCatalogManagement/v5` | `ProductCatalog`, `Category`, `ProductOffering`, `ProductSpecification` |
+| TMF622 Product Ordering | `productOrdering/v5` | `ProductOrder` |
+| TMF637 Product Inventory | `productInventory/v5` | `Product` |
+| TMF632 Party Management | `partyManagement/v5` | `Individual`, `Organization` |
+| TMF669 Party Role | `partyRoleManagement/v5` | `PartyRole` |
+| TMF666 Account Management | `accountManagement/v5` | `BillingAccount`, `FinancialAccount`, `BillingCycleSpecification` |
+| TMF678 Customer Bill | `customerBill/v5` | `AppliedCustomerBillingRate` |
+| TMF648 Quote | `quoteManagement/v5` | `Quote` |
+| TMF679 Product Offering Qualification | `productOfferingQualification/v5` | `CheckProductOfferingQualification`, `QueryProductOfferingQualification` |
+| TMF699 Sales Management | `salesManagement/v4` | `SalesLead` |
+| TMF723 Policy Management | `policyManagement/v5` | `PolicyDomain`, `ManagedPolicy`, `ManagedPolicyVariable`, `PolicyCatalog` |
+| TMF638 Service Inventory | `serviceInventory/v5` | `Service` |
+| TMF639 Resource Inventory | `resourceInventory/v5` | `Resource` |
+| TMF634 Resource Catalog | `resourceCatalog/v5` | `ResourceSpecification` |
+| TMF685 Resource Pool | `resourcePool/v5` | `ResourcePool`, `ResourcePoolSpecification`, `CapacitySpecification` |
+| TMF676 Payment | `payment/v4` | `PaymentPlan` |
+| TMF760 Product Configuration | *(entity models only)* | `CheckProductConfiguration.from_order()` |
+
+## How it works
+
+Every entity is a `@dataclass` inheriting from `Entity`, which provides recursive `from_dict` / `to_dict` / `to_json`. Type resolution uses each field's type hints plus the payload's `@type` discriminator, so nested and polymorphic structures (e.g. `RelatedPartyRefOrPartyRoleRef`, price alterations, characteristic subtypes) deserialize into the correct classes.
+
+Entities that map to REST resources also inherit `BaseCRUDMixin`, which implements `from_id`, `create`, `read`, `update` (JSON PATCH semantics), `query_get`, and `delete` against `{context.api_base_url}/{resource_path}`. A `Context` dataclass carries `api_base_url`, `access_token`, `headers`, an optional logger, and OAuth-related fields — pass it to every call; there is no global state.
+
+## Status
+
+Alpha. The entity models and serialization are exercised by a pure-offline test suite; the CRUD layer follows the TMF REST conventions, but server implementations vary in the extensions and versions they accept. Issues and PRs welcome.
+
+## License & trademark notice
+
+MIT — see [LICENSE](LICENSE).
+
+This is an **unofficial, community project**. TM Forum® and the TMF API names are trademarks of TM Forum. This project is not affiliated with, endorsed, or sponsored by TM Forum. The Open API specifications referenced are © TM Forum.

tmforum-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "tmforum"
+version = "0.1.0"
+description = "Unofficial Python SDK for TM Forum Open APIs: dataclass entity models with @type-aware serialization and REST CRUD helpers"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Alex Chadyuk", email = "alex@chady.uk" }]
+keywords = [
+  "tmforum",
+  "tmf",
+  "oda",
+  "open-api",
+  "bss",
+  "telecom",
+  "product-catalog",
+  "product-ordering",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Telecommunications Industry",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = ["requests>=2.25"]
+
+[project.urls]
+Homepage = "https://github.com/alex-chadyuk/tmforum"
+Issues = "https://github.com/alex-chadyuk/tmforum/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=7", "build", "twine"]