movethewheels-sdk 2026.1107.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,172 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # poetry
98
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102
+ #poetry.lock
103
+
104
+ # pdm
105
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106
+ #pdm.lock
107
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108
+ # in version control.
109
+ # https://pdm.fming.dev/#use-with-ide
110
+ .pdm.toml
111
+
112
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113
+ __pypackages__/
114
+
115
+ # Celery stuff
116
+ celerybeat-schedule
117
+ celerybeat.pid
118
+
119
+ # SageMath parsed files
120
+ *.sage.py
121
+
122
+ # Environments
123
+ .env
124
+ .venv
125
+ env/
126
+ venv/
127
+ ENV/
128
+ env.bak/
129
+ venv.bak/
130
+
131
+ # Spyder project settings
132
+ .spyderproject
133
+ .spyproject
134
+
135
+ # Rope project settings
136
+ .ropeproject
137
+
138
+ # mkdocs documentation
139
+ /site
140
+
141
+ # mypy
142
+ .mypy_cache/
143
+ .dmypy.json
144
+ dmypy.json
145
+
146
+ # Pyre type checker
147
+ .pyre/
148
+
149
+ # pytype static type analyzer
150
+ .pytype/
151
+
152
+ # Cython debug symbols
153
+ cython_debug/
154
+
155
+ # PyCharm
156
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157
+ # be added to the global gitignore or merged into this project gitignore. For a PyCharm
158
+ # project, it is recommended to include the following directory since it contains user-specific
159
+ # configurations:
160
+ .idea/
161
+
162
+ # VSCode
163
+ .vscode/
164
+
165
+ # OS generated files
166
+ .DS_Store
167
+ .DS_Store?
168
+ ._*
169
+ .Spotlight-V100
170
+ .Trashes
171
+ ehthumbs.db
172
+ Thumbs.db
@@ -0,0 +1,30 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [CalVer](https://calver.org/) (`YYYY.MDD.PATCH`).
7
+
8
+ ## [Unreleased]
9
+
10
+ ### Changed
11
+ - Rewrote the SDK as a thin shell over `burdenoff-sdk-libs`. The hand-vendored
12
+ per-feature module tree (client, types, auth, user, workspace, rbac, team,
13
+ project, resources, billing, organization, payment, quota, store, support,
14
+ usage, utils, addon, plan, product) and its mock-based tests were removed.
15
+ - All module surfaces are now nested under their owning module. The Movethewheels
16
+ domain bundle is reached via `sdk.movethewheels.<entity>` (customers, drivers,
17
+ vehicles, products, warehouses, inventory, orders, shipments, tracking, routes,
18
+ marketplace, reports, settings, data, analytics).
19
+
20
+ ### Added
21
+ - `MovethewheelsSDK` facade mounting 23 modules from `burdenoff-sdk-libs`: the
22
+ shared generic set plus the `movethewheels` domain module and the standalone
23
+ `sandbox` module.
24
+ - Shared-gateway defaults and the `burdenoff_cli_movethewheels` OIDC client id.
25
+ - `py.typed` marker shipped in the wheel; strict mypy in CI.
26
+ - Real-construction smoke tests (no mocks).
27
+
28
+ ### Removed
29
+ - Vendored module directories under `src/movethewheels_sdk/` and the mock-based
30
+ unit tests.
@@ -0,0 +1,9 @@
1
+ Copyright (c) 2025 Burdenoff Consultancy Services Private Limited, Algoshred Technologies Private Limited and all sister companies.
2
+
3
+ All rights reserved.
4
+
5
+ This software is proprietary and confidential. Unauthorized copying, modification, distribution, or use of this software, via any medium, is strictly prohibited without the express written permission of the copyright holders.
6
+
7
+ 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.
8
+
9
+ For licensing inquiries, please contact: legal@algoshred.com
@@ -0,0 +1,204 @@
1
+ Metadata-Version: 2.5
2
+ Name: movethewheels-sdk
3
+ Version: 2026.1107.1
4
+ Summary: Official Python SDK for Movethewheels — thin shell over burdenoff-sdk-libs
5
+ Project-URL: Homepage, https://github.com/algoshred/movethewheels-sdk-python
6
+ Project-URL: Documentation, https://docs.algoshred.com/sdk/python
7
+ Project-URL: Repository, https://github.com/algoshred/movethewheels-sdk-python
8
+ Project-URL: Issues, https://github.com/algoshred/movethewheels-sdk-python/issues
9
+ Project-URL: Changelog, https://github.com/algoshred/movethewheels-sdk-python/blob/main/CHANGELOG.md
10
+ Author-email: "Vignesh T.V" <vignesh@algoshred.com>
11
+ Maintainer-email: "Vignesh T.V" <vignesh@algoshred.com>
12
+ License: Copyright (c) 2025 Burdenoff Consultancy Services Private Limited, Algoshred Technologies Private Limited and all sister companies.
13
+
14
+ All rights reserved.
15
+
16
+ This software is proprietary and confidential. Unauthorized copying, modification, distribution, or use of this software, via any medium, is strictly prohibited without the express written permission of the copyright holders.
17
+
18
+ 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.
19
+
20
+ For licensing inquiries, please contact: legal@algoshred.com
21
+ License-File: LICENSE
22
+ Keywords: api-client,burdenoff,delivery,fleet,graphql,logistics,movethewheels,python,sdk
23
+ Classifier: Development Status :: 3 - Alpha
24
+ Classifier: Intended Audience :: Developers
25
+ Classifier: License :: Other/Proprietary License
26
+ Classifier: Operating System :: OS Independent
27
+ Classifier: Programming Language :: Python :: 3
28
+ Classifier: Programming Language :: Python :: 3.10
29
+ Classifier: Programming Language :: Python :: 3.11
30
+ Classifier: Programming Language :: Python :: 3.12
31
+ Classifier: Programming Language :: Python :: 3.13
32
+ Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
33
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
34
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
35
+ Requires-Python: >=3.10
36
+ Requires-Dist: burdenoff-sdk-libs>=2026.1107.1
37
+ Requires-Dist: httpx>=0.24.0
38
+ Requires-Dist: typing-extensions>=4.0.0; python_version < '3.11'
39
+ Provides-Extra: dev
40
+ Requires-Dist: black>=23.0.0; extra == 'dev'
41
+ Requires-Dist: flake8>=6.0.0; extra == 'dev'
42
+ Requires-Dist: isort>=5.12.0; extra == 'dev'
43
+ Requires-Dist: mypy>=1.0.0; extra == 'dev'
44
+ Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
45
+ Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
46
+ Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
47
+ Requires-Dist: pytest>=7.0.0; extra == 'dev'
48
+ Provides-Extra: docs
49
+ Requires-Dist: sphinx-autodoc-typehints>=1.19.0; extra == 'docs'
50
+ Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == 'docs'
51
+ Requires-Dist: sphinx>=6.0.0; extra == 'docs'
52
+ Provides-Extra: test
53
+ Requires-Dist: pytest-asyncio>=0.21.0; extra == 'test'
54
+ Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
55
+ Requires-Dist: pytest>=7.0.0; extra == 'test'
56
+ Requires-Dist: respx>=0.21.0; extra == 'test'
57
+ Description-Content-Type: text/markdown
58
+
59
+ # movethewheels-sdk
60
+
61
+ Official Python SDK for **Movethewheels** — a logistics, fleet, and delivery-operations platform on the Burdenoff platform.
62
+
63
+ > **Pre-launch notice:** Movethewheels is launching in 2026. This package is published ahead of general availability so integrators can build early. There is no live production service yet — [join the waitlist at movethewheels.com](https://movethewheels.com) to get early access.
64
+
65
+ This SDK is a **thin shell** over [`burdenoff-sdk-libs`](https://github.com/algoshred/sdk-libs-python). It mounts the shared platform modules plus the Movethewheels domain module and a standalone sandbox module, and exposes them as one ergonomic, fully typed client.
66
+
67
+ ## Features
68
+
69
+ - Async/await throughout, built on `httpx`
70
+ - Dual-endpoint GraphQL client (workspace + global gateways)
71
+ - 23 mounted modules: the shared generic set + `movethewheels` + `sandbox`
72
+ - Multiple auth flows: email/password, device code, PKCE, client credentials
73
+ - Automatic token refresh
74
+ - Typed error hierarchy
75
+ - Full type hints with `py.typed` marker
76
+
77
+ ## Installation
78
+
79
+ ```bash
80
+ pip install movethewheels-sdk
81
+
82
+ # Development install
83
+ pip install -e ".[dev]"
84
+ ```
85
+
86
+ ## Quick Start
87
+
88
+ ```python
89
+ import asyncio
90
+ from movethewheels_sdk import MovethewheelsSDK
91
+
92
+
93
+ async def main():
94
+ # Defaults to the shared prod gateways and the burdenoff_cli_movethewheels
95
+ # OIDC client. Override the endpoints for local dev.
96
+ sdk = MovethewheelsSDK()
97
+
98
+ # Sign in with email/password
99
+ await sdk.auth.sign_in(email="user@example.com", password="secret")
100
+
101
+ # Movethewheels-domain operations are nested under sdk.movethewheels
102
+ customers = await sdk.movethewheels.customers.list()
103
+ orders = await sdk.movethewheels.orders.list()
104
+
105
+ # Shared cross-product modules are mounted at the top level
106
+ tags = await sdk.tags.list()
107
+
108
+ await sdk.close()
109
+
110
+
111
+ asyncio.run(main())
112
+ ```
113
+
114
+ ## Nested namespace
115
+
116
+ Per the platform mandate (no compatibility shim), every module surface is nested
117
+ under its owning module. The Movethewheels domain bundle keeps its sub-entities
118
+ nested:
119
+
120
+ ```python
121
+ await sdk.movethewheels.customers.list()
122
+ await sdk.movethewheels.drivers.list()
123
+ await sdk.movethewheels.vehicles.list()
124
+ await sdk.movethewheels.warehouses.list()
125
+ await sdk.movethewheels.inventory.list()
126
+ await sdk.movethewheels.orders.list()
127
+ await sdk.movethewheels.shipments.list()
128
+ await sdk.movethewheels.tracking.list()
129
+ await sdk.movethewheels.routes.list()
130
+ await sdk.movethewheels.reports.list()
131
+ await sdk.movethewheels.analytics.dashboard()
132
+ ```
133
+
134
+ ## Modules
135
+
136
+ All methods are async. The following modules are mounted on the `MovethewheelsSDK`
137
+ instance: `auth`, `billing`, `channels`, `conversations`, `devportal`,
138
+ `export`, `files`, `groups`, `health`, `integrations`, `movethewheels`,
139
+ `notifications`, `organizations`, `products`, `rbac`, `sandbox`, `scheduler`,
140
+ `security`, `store`, `support`, `tags`, `tours`, `workspaces`.
141
+
142
+ ## Configuration
143
+
144
+ ```python
145
+ from movethewheels_sdk import MovethewheelsSDK
146
+
147
+ sdk = MovethewheelsSDK(
148
+ workspace_endpoint="https://graphqlworkspaces.burdenoff.com/workspaces/graphql",
149
+ global_endpoint="https://graphql.burdenoff.com/global/graphql",
150
+ client_id="burdenoff_cli_movethewheels", # default
151
+ oidc_issuer=None, # derived from global_endpoint
152
+ api_key=None,
153
+ access_token=None,
154
+ refresh_token=None,
155
+ workspace_token=None,
156
+ timeout=30.0,
157
+ auto_refresh=True,
158
+ )
159
+ ```
160
+
161
+ ## Error Handling
162
+
163
+ ```python
164
+ from movethewheels_sdk import (
165
+ MovethewheelsError,
166
+ AuthenticationError,
167
+ AuthorizationError,
168
+ NetworkError,
169
+ ValidationError,
170
+ RateLimitError,
171
+ DeviceCodeExpiredError,
172
+ DeviceCodeDeniedError,
173
+ )
174
+
175
+ try:
176
+ await sdk.auth.sign_in(email="user@example.com", password="wrong")
177
+ except AuthenticationError:
178
+ print("Invalid credentials")
179
+ except NetworkError:
180
+ print("Could not reach the API")
181
+ except MovethewheelsError as e:
182
+ print(f"SDK error: {e}")
183
+ ```
184
+
185
+ ## Development
186
+
187
+ ```bash
188
+ python -m venv .venv && source .venv/bin/activate
189
+ pip install -e ".[dev]"
190
+
191
+ make format # black + isort
192
+ make lint # flake8
193
+ make type-check # mypy (strict)
194
+ make test # pytest
195
+ make sanity # format-check + lint + type-check + test (cov>=80) + build
196
+ ```
197
+
198
+ ## License
199
+
200
+ Proprietary — Copyright Burdenoff Consultancy Services Pvt. Ltd.
201
+
202
+ ## Support
203
+
204
+ - Issues: [GitHub Issues](https://github.com/algoshred/movethewheels-sdk-python/issues)
@@ -0,0 +1,146 @@
1
+ # movethewheels-sdk
2
+
3
+ Official Python SDK for **Movethewheels** — a logistics, fleet, and delivery-operations platform on the Burdenoff platform.
4
+
5
+ > **Pre-launch notice:** Movethewheels is launching in 2026. This package is published ahead of general availability so integrators can build early. There is no live production service yet — [join the waitlist at movethewheels.com](https://movethewheels.com) to get early access.
6
+
7
+ This SDK is a **thin shell** over [`burdenoff-sdk-libs`](https://github.com/algoshred/sdk-libs-python). It mounts the shared platform modules plus the Movethewheels domain module and a standalone sandbox module, and exposes them as one ergonomic, fully typed client.
8
+
9
+ ## Features
10
+
11
+ - Async/await throughout, built on `httpx`
12
+ - Dual-endpoint GraphQL client (workspace + global gateways)
13
+ - 23 mounted modules: the shared generic set + `movethewheels` + `sandbox`
14
+ - Multiple auth flows: email/password, device code, PKCE, client credentials
15
+ - Automatic token refresh
16
+ - Typed error hierarchy
17
+ - Full type hints with `py.typed` marker
18
+
19
+ ## Installation
20
+
21
+ ```bash
22
+ pip install movethewheels-sdk
23
+
24
+ # Development install
25
+ pip install -e ".[dev]"
26
+ ```
27
+
28
+ ## Quick Start
29
+
30
+ ```python
31
+ import asyncio
32
+ from movethewheels_sdk import MovethewheelsSDK
33
+
34
+
35
+ async def main():
36
+ # Defaults to the shared prod gateways and the burdenoff_cli_movethewheels
37
+ # OIDC client. Override the endpoints for local dev.
38
+ sdk = MovethewheelsSDK()
39
+
40
+ # Sign in with email/password
41
+ await sdk.auth.sign_in(email="user@example.com", password="secret")
42
+
43
+ # Movethewheels-domain operations are nested under sdk.movethewheels
44
+ customers = await sdk.movethewheels.customers.list()
45
+ orders = await sdk.movethewheels.orders.list()
46
+
47
+ # Shared cross-product modules are mounted at the top level
48
+ tags = await sdk.tags.list()
49
+
50
+ await sdk.close()
51
+
52
+
53
+ asyncio.run(main())
54
+ ```
55
+
56
+ ## Nested namespace
57
+
58
+ Per the platform mandate (no compatibility shim), every module surface is nested
59
+ under its owning module. The Movethewheels domain bundle keeps its sub-entities
60
+ nested:
61
+
62
+ ```python
63
+ await sdk.movethewheels.customers.list()
64
+ await sdk.movethewheels.drivers.list()
65
+ await sdk.movethewheels.vehicles.list()
66
+ await sdk.movethewheels.warehouses.list()
67
+ await sdk.movethewheels.inventory.list()
68
+ await sdk.movethewheels.orders.list()
69
+ await sdk.movethewheels.shipments.list()
70
+ await sdk.movethewheels.tracking.list()
71
+ await sdk.movethewheels.routes.list()
72
+ await sdk.movethewheels.reports.list()
73
+ await sdk.movethewheels.analytics.dashboard()
74
+ ```
75
+
76
+ ## Modules
77
+
78
+ All methods are async. The following modules are mounted on the `MovethewheelsSDK`
79
+ instance: `auth`, `billing`, `channels`, `conversations`, `devportal`,
80
+ `export`, `files`, `groups`, `health`, `integrations`, `movethewheels`,
81
+ `notifications`, `organizations`, `products`, `rbac`, `sandbox`, `scheduler`,
82
+ `security`, `store`, `support`, `tags`, `tours`, `workspaces`.
83
+
84
+ ## Configuration
85
+
86
+ ```python
87
+ from movethewheels_sdk import MovethewheelsSDK
88
+
89
+ sdk = MovethewheelsSDK(
90
+ workspace_endpoint="https://graphqlworkspaces.burdenoff.com/workspaces/graphql",
91
+ global_endpoint="https://graphql.burdenoff.com/global/graphql",
92
+ client_id="burdenoff_cli_movethewheels", # default
93
+ oidc_issuer=None, # derived from global_endpoint
94
+ api_key=None,
95
+ access_token=None,
96
+ refresh_token=None,
97
+ workspace_token=None,
98
+ timeout=30.0,
99
+ auto_refresh=True,
100
+ )
101
+ ```
102
+
103
+ ## Error Handling
104
+
105
+ ```python
106
+ from movethewheels_sdk import (
107
+ MovethewheelsError,
108
+ AuthenticationError,
109
+ AuthorizationError,
110
+ NetworkError,
111
+ ValidationError,
112
+ RateLimitError,
113
+ DeviceCodeExpiredError,
114
+ DeviceCodeDeniedError,
115
+ )
116
+
117
+ try:
118
+ await sdk.auth.sign_in(email="user@example.com", password="wrong")
119
+ except AuthenticationError:
120
+ print("Invalid credentials")
121
+ except NetworkError:
122
+ print("Could not reach the API")
123
+ except MovethewheelsError as e:
124
+ print(f"SDK error: {e}")
125
+ ```
126
+
127
+ ## Development
128
+
129
+ ```bash
130
+ python -m venv .venv && source .venv/bin/activate
131
+ pip install -e ".[dev]"
132
+
133
+ make format # black + isort
134
+ make lint # flake8
135
+ make type-check # mypy (strict)
136
+ make test # pytest
137
+ make sanity # format-check + lint + type-check + test (cov>=80) + build
138
+ ```
139
+
140
+ ## License
141
+
142
+ Proprietary — Copyright Burdenoff Consultancy Services Pvt. Ltd.
143
+
144
+ ## Support
145
+
146
+ - Issues: [GitHub Issues](https://github.com/algoshred/movethewheels-sdk-python/issues)
@@ -0,0 +1,20 @@
1
+ # Minimal makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line, and also
5
+ # from the environment for the first two.
6
+ SPHINXOPTS ?=
7
+ SPHINXBUILD ?= sphinx-build
8
+ SOURCEDIR = .
9
+ BUILDDIR = _build
10
+
11
+ # Put it first so that "make" without argument is like "make help".
12
+ help:
13
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14
+
15
+ .PHONY: help Makefile
16
+
17
+ # Catch-all target: route all unknown targets to Sphinx using the new
18
+ # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19
+ %: Makefile
20
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -0,0 +1,57 @@
1
+ # Configuration file for the Sphinx documentation builder.
2
+ #
3
+ # For the full list of built-in configuration values, see the documentation:
4
+ # https://www.sphinx-doc.org/en/master/usage/configuration.html
5
+
6
+ # -- Project information -----------------------------------------------------
7
+ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8
+
9
+ project = 'Movethewheels SDK Python'
10
+ copyright = '2026, Vignesh T.V'
11
+ author = 'Vignesh T.V'
12
+ release = '2026.627.1'
13
+
14
+ # -- General configuration ---------------------------------------------------
15
+ # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16
+
17
+ extensions = [
18
+ 'sphinx.ext.autodoc',
19
+ 'sphinx.ext.automodule',
20
+ 'sphinx.ext.viewcode',
21
+ 'sphinx.ext.napoleon',
22
+ 'sphinx_autodoc_typehints',
23
+ ]
24
+
25
+ templates_path = ['_templates']
26
+ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
27
+
28
+ # -- Options for HTML output -------------------------------------------------
29
+ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
30
+
31
+ html_theme = 'sphinx_rtd_theme'
32
+ html_static_path = ['_static']
33
+
34
+ # -- Options for autodoc ----------------------------------------------------
35
+ autodoc_default_options = {
36
+ 'members': True,
37
+ 'member-order': 'bysource',
38
+ 'special-members': '__init__',
39
+ 'undoc-members': True,
40
+ 'exclude-members': '__weakref__'
41
+ }
42
+
43
+ # -- Options for napoleon ---------------------------------------------------
44
+ napoleon_google_docstring = True
45
+ napoleon_numpy_docstring = True
46
+ napoleon_include_init_with_doc = False
47
+ napoleon_include_private_with_doc = False
48
+ napoleon_include_special_with_doc = True
49
+ napoleon_use_admonition_for_examples = False
50
+ napoleon_use_admonition_for_notes = False
51
+ napoleon_use_admonition_for_references = False
52
+ napoleon_use_ivar = False
53
+ napoleon_use_param = True
54
+ napoleon_use_rtype = True
55
+ napoleon_preprocess_types = False
56
+ napoleon_type_aliases = None
57
+ napoleon_attr_annotations = True
@@ -0,0 +1,18 @@
1
+ Welcome to Movethewheels SDK Python's documentation!
2
+ =============================================
3
+
4
+ .. toctree::
5
+ :maxdepth: 2
6
+ :caption: Contents:
7
+
8
+ quickstart
9
+ api
10
+ examples
11
+ contributing
12
+
13
+ Indices and tables
14
+ ==================
15
+
16
+ * :ref:`genindex`
17
+ * :ref:`modindex`
18
+ * :ref:`search`
@@ -0,0 +1,36 @@
1
+ """Basic usage example for the Movethewheels Python SDK.
2
+
3
+ Demonstrates how to:
4
+ 1. Initialize the SDK (defaults to the shared Burdenoff prod gateways)
5
+ 2. Sign in with email + password
6
+ 3. Access the nested Movethewheels-domain API and a shared module
7
+ 4. Clean up
8
+ """
9
+
10
+ import asyncio
11
+
12
+ from movethewheels_sdk import MovethewheelsSDK
13
+
14
+
15
+ async def main() -> None:
16
+ # Defaults to the shared prod gateways and the burdenoff_cli_movethewheels
17
+ # OIDC client. Override workspace_endpoint / global_endpoint for local dev.
18
+ sdk = MovethewheelsSDK()
19
+
20
+ try:
21
+ # Sign in with email/password (delegated to the shared auth module).
22
+ await sdk.auth.sign_in(email="user@example.com", password="your-password")
23
+
24
+ # Movethewheels-domain operations are nested under sdk.movethewheels.
25
+ customers = await sdk.movethewheels.customers.list()
26
+ print(f"Found {len(customers)} customers")
27
+
28
+ # Shared cross-product modules are mounted at the top level.
29
+ tags = await sdk.tags.list()
30
+ print(f"Found {len(tags)} tags")
31
+ finally:
32
+ await sdk.close()
33
+
34
+
35
+ if __name__ == "__main__":
36
+ asyncio.run(main())