Open developer tooling for TMForum Open API implementations.

The BSS/OSS industry runs on TMForum standards. Every major vendor implements the same 94+ APIs. The developer tooling around them has never kept up. TMF DevKit fills that gap.

pip install tmf-mock · docker pull mchavan23/tmf-mock

Unlike generic OpenAPI mockers, tmf-mock understands the telecom domain.

• Domain-aware seed data — DSLAM, OLT, ONT, BTS, DSL ports with real SNR margins, IMSI, MSISDN
• Cross-API referential integrity — TMF641 ServiceOrder → TMF638 Service → TMF639 Resource, enforced
• Lifecycle state machines from the TMForum v4.0.0 spec, enforced on every PATCH
• Covers TMF638 (Service Inventory), TMF639 (Resource Inventory), TMF641 (Service Ordering)

pip install tmf-mock
tmf-mock start
# → http://localhost:8000/docs

pip install tmf-lint · docker pull mchavan23/tmf-lint

Points tmf-lint at any running TMF API and it tells you what is and isn't conformant — like ESLint, but for TMF implementations.

• 39 rules across 5 categories: HTTP conventions, mandatory fields, lifecycle states, referential integrity, pagination
• Works against any live endpoint — your own server, a mock, a vendor's sandbox
• JSON output for CI/CD integration
• Covers TMF638, TMF639, TMF641

pip install tmf-lint
tmf-lint check --base-url http://localhost:8000 --apis TMF638,TMF639,TMF641

pip install tmf-spec-parser

Fetches TMForum OpenAPI specs from GitHub and extracts structured metadata: entities, fields, lifecycle states, cross-API references, and API relationships. Produces tmf_data.json consumed by tmf-map.

• Covers all 16 core TMF APIs
• Two-layer design: auto-extracted from live specs + curated baseline for consistency
• Outputs JSON, ES module, and TypeScript formats
• Used to power the tmf-map visualization

pip install tmf-spec-parser
tmf-spec-parser generate --out tmf_data.json --js

Live → tmf-devkit.github.io/tmf-map

A visual explorer for the 16 core TMF Open APIs and the relationships between them.

• Force-directed graph of 16 APIs, colour-coded by domain (Customer / Product / Service / Resource / Engagement / Common)
• Click any node to see its entity model, mandatory/optional fields, lifecycle state machine, and cross-API references
• Integration pattern overlays: Order-to-Activate, Catalog-to-Inventory, Trouble-to-Resolve
• Search, filter by domain, zoom/pan
• Data generated by tmf-spec-parser and refreshed from live TMForum specs

TMForum defines what telecom systems should do. TMF DevKit builds the tools that help developers implement it.

All published modules are open source under the Apache 2.0 license.

Built by Manoj Chavan — 16+ years in BSS/OSS, TMForum certified (Open API, Information Framework, Business Process Framework).