marpledata 3.2.2__tar.gz → 3.2.3__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.
Files changed (47) hide show
  1. {marpledata-3.2.2 → marpledata-3.2.3}/.gitignore +172 -172
  2. {marpledata-3.2.2 → marpledata-3.2.3}/.python-version +1 -1
  3. {marpledata-3.2.2 → marpledata-3.2.3}/AGENTS.md +29 -29
  4. {marpledata-3.2.2 → marpledata-3.2.3}/CHANGELOG.md +45 -39
  5. {marpledata-3.2.2 → marpledata-3.2.3}/CONTRIBUTING.md +74 -76
  6. {marpledata-3.2.2 → marpledata-3.2.3}/LICENSE +13 -13
  7. {marpledata-3.2.2 → marpledata-3.2.3}/PKG-INFO +1 -1
  8. {marpledata-3.2.2 → marpledata-3.2.3}/README.md +209 -209
  9. {marpledata-3.2.2 → marpledata-3.2.3}/docs/DEPLOYMENT.md +24 -24
  10. {marpledata-3.2.2 → marpledata-3.2.3}/docs/_static/custom.css +4 -4
  11. {marpledata-3.2.2 → marpledata-3.2.3}/docs/api/db.rst +17 -17
  12. {marpledata-3.2.2 → marpledata-3.2.3}/docs/api/insight.rst +8 -8
  13. {marpledata-3.2.2 → marpledata-3.2.3}/docs/api.rst +8 -8
  14. {marpledata-3.2.2 → marpledata-3.2.3}/docs/conf.py +128 -128
  15. {marpledata-3.2.2 → marpledata-3.2.3}/docs/getting-started.rst +70 -70
  16. {marpledata-3.2.2 → marpledata-3.2.3}/docs/index.rst +12 -12
  17. {marpledata-3.2.2 → marpledata-3.2.3}/docs/tutorials.rst +84 -84
  18. {marpledata-3.2.2 → marpledata-3.2.3}/example.py +58 -58
  19. {marpledata-3.2.2 → marpledata-3.2.3}/examples_race.csv +12501 -12501
  20. {marpledata-3.2.2 → marpledata-3.2.3}/pyproject.toml +67 -67
  21. {marpledata-3.2.2 → marpledata-3.2.3}/src/marple/__init__.py +6 -6
  22. {marpledata-3.2.2 → marpledata-3.2.3}/src/marple/db/__init__.py +484 -484
  23. {marpledata-3.2.2 → marpledata-3.2.3}/src/marple/db/constants.py +19 -19
  24. {marpledata-3.2.2 → marpledata-3.2.3}/src/marple/db/dataset.py +512 -512
  25. {marpledata-3.2.2 → marpledata-3.2.3}/src/marple/db/datastream.py +243 -243
  26. {marpledata-3.2.2 → marpledata-3.2.3}/src/marple/db/signal.py +81 -81
  27. {marpledata-3.2.2 → marpledata-3.2.3}/src/marple/insight.py +184 -220
  28. {marpledata-3.2.2 → marpledata-3.2.3}/src/marple/utils.py +192 -192
  29. {marpledata-3.2.2 → marpledata-3.2.3}/tests/test_reliability.py +102 -102
  30. {marpledata-3.2.2 → marpledata-3.2.3}/tests/test_sdk.py +347 -347
  31. {marpledata-3.2.2 → marpledata-3.2.3}/uv.lock +1354 -1354
  32. marpledata-3.2.2/.uv-cache/.gitignore +0 -1
  33. marpledata-3.2.2/.uv-cache/.lock +0 -0
  34. marpledata-3.2.2/.uv-cache/CACHEDIR.TAG +0 -1
  35. marpledata-3.2.2/.uv-cache/interpreter-v4/c2c2931c8a99aae1/588e1e7c128e2872.msgpack +0 -0
  36. marpledata-3.2.2/.uv-cache/sdists-v9/.gitignore +0 -0
  37. marpledata-3.2.2/docs/api/marple.Insight.rst +0 -33
  38. marpledata-3.2.2/docs/api/marple.db.DB.rst +0 -49
  39. marpledata-3.2.2/docs/api/marple.db.DataStream.rst +0 -49
  40. marpledata-3.2.2/docs/api/marple.db.Dataset.rst +0 -58
  41. marpledata-3.2.2/docs/api/marple.db.DatasetList.rst +0 -40
  42. marpledata-3.2.2/docs/api/marple.db.Signal.rst +0 -46
  43. marpledata-3.2.2/src/marple/profile.json +0 -95
  44. {marpledata-3.2.2 → marpledata-3.2.3}/docs/_static/favicon.png +0 -0
  45. {marpledata-3.2.2 → marpledata-3.2.3}/docs/_static/logo.png +0 -0
  46. {marpledata-3.2.2 → marpledata-3.2.3}/pytest.xml +0 -0
  47. {marpledata-3.2.2 → marpledata-3.2.3}/src/marple/py.typed +0 -0
@@ -1,172 +1,172 @@
1
- lol.py
2
- .mdb_cache/
3
- matlab/bin/
4
-
5
- python/docs/_build/
6
- python/docs/api/marple.*.rst
7
-
8
- # Default ignored files
9
- /shelf/
10
- /workspace.xml
11
-
12
- # Byte-compiled / optimized / DLL files
13
- __pycache__/
14
- *.py[cod]
15
- *$py.class
16
-
17
- # C extensions
18
- *.so
19
-
20
- # Distribution / packaging
21
- .Python
22
- build/
23
- develop-eggs/
24
- dist/
25
- downloads/
26
- eggs/
27
- .eggs/
28
- lib/
29
- lib64/
30
- parts/
31
- sdist/
32
- var/
33
- wheels/
34
- share/python-wheels/
35
- *.egg-info/
36
- .installed.cfg
37
- *.egg
38
- MANIFEST
39
-
40
- # PyInstaller
41
- # Usually these files are written by a python script from a template
42
- # before PyInstaller builds the exe, so as to inject date/other infos into it.
43
- *.manifest
44
- *.spec
45
-
46
- # Installer logs
47
- pip-log.txt
48
- pip-delete-this-directory.txt
49
-
50
- # Unit test / coverage reports
51
- htmlcov/
52
- .tox/
53
- .nox/
54
- .coverage
55
- .coverage.*
56
- .cache
57
- nosetests.xml
58
- coverage.xml
59
- *.cover
60
- *.py,cover
61
- .hypothesis/
62
- .pytest_cache/
63
- cover/
64
-
65
- # Translations
66
- *.mo
67
- *.pot
68
-
69
- # Django stuff:
70
- *.log
71
- local_settings.py
72
- db.sqlite3
73
- db.sqlite3-journal
74
-
75
- # Flask stuff:
76
- instance/
77
- .webassets-cache
78
-
79
- # Scrapy stuff:
80
- .scrapy
81
-
82
- # Sphinx documentation
83
- docs/_build/
84
-
85
- # PyBuilder
86
- .pybuilder/
87
- target/
88
-
89
- # Jupyter Notebook
90
- .ipynb_checkpoints
91
-
92
- # IPython
93
- profile_default/
94
- ipython_config.py
95
-
96
- # pyenv
97
- # For a library or package, you might want to ignore these files since the code is
98
- # intended to run in multiple environments; otherwise, check them in:
99
- # .python-version
100
-
101
- # pipenv
102
- # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
103
- # However, in case of collaboration, if having platform-specific dependencies or dependencies
104
- # having no cross-platform support, pipenv may install dependencies that don't work, or not
105
- # install all needed dependencies.
106
- #Pipfile.lock
107
-
108
- # poetry
109
- # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
110
- # This is especially recommended for binary packages to ensure reproducibility, and is more
111
- # commonly ignored for libraries.
112
- # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
113
- #poetry.lock
114
-
115
- # pdm
116
- # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
117
- #pdm.lock
118
- # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
119
- # in version control.
120
- # https://pdm.fming.dev/#use-with-ide
121
- .pdm.toml
122
-
123
- # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
124
- __pypackages__/
125
-
126
- # Celery stuff
127
- celerybeat-schedule
128
- celerybeat.pid
129
-
130
- # SageMath parsed files
131
- *.sage.py
132
-
133
- # Environments
134
- .env
135
- .venv
136
- env/
137
- venv/
138
- ENV/
139
- env.bak/
140
- venv.bak/
141
-
142
- # Spyder project settings
143
- .spyderproject
144
- .spyproject
145
-
146
- # Rope project settings
147
- .ropeproject
148
-
149
- # mkdocs documentation
150
- /site
151
-
152
- # mypy
153
- .mypy_cache/
154
- .dmypy.json
155
- dmypy.json
156
-
157
- # Pyre type checker
158
- .pyre/
159
-
160
- # pytype static type analyzer
161
- .pytype/
162
-
163
- # Cython debug symbols
164
- cython_debug/
165
-
166
- # PyCharm
167
- # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
168
- # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
169
- # and can be added to the global gitignore or merged into this file. For a more nuclear
170
- # option (not recommended) you can uncomment the following to ignore the entire idea folder.
171
- .idea/
172
- *.env
1
+ lol.py
2
+ .mdb_cache/
3
+ matlab/bin/
4
+
5
+ python/docs/_build/
6
+ python/docs/api/marple.*.rst
7
+
8
+ # Default ignored files
9
+ /shelf/
10
+ /workspace.xml
11
+
12
+ # Byte-compiled / optimized / DLL files
13
+ __pycache__/
14
+ *.py[cod]
15
+ *$py.class
16
+
17
+ # C extensions
18
+ *.so
19
+
20
+ # Distribution / packaging
21
+ .Python
22
+ build/
23
+ develop-eggs/
24
+ dist/
25
+ downloads/
26
+ eggs/
27
+ .eggs/
28
+ lib/
29
+ lib64/
30
+ parts/
31
+ sdist/
32
+ var/
33
+ wheels/
34
+ share/python-wheels/
35
+ *.egg-info/
36
+ .installed.cfg
37
+ *.egg
38
+ MANIFEST
39
+
40
+ # PyInstaller
41
+ # Usually these files are written by a python script from a template
42
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
43
+ *.manifest
44
+ *.spec
45
+
46
+ # Installer logs
47
+ pip-log.txt
48
+ pip-delete-this-directory.txt
49
+
50
+ # Unit test / coverage reports
51
+ htmlcov/
52
+ .tox/
53
+ .nox/
54
+ .coverage
55
+ .coverage.*
56
+ .cache
57
+ nosetests.xml
58
+ coverage.xml
59
+ *.cover
60
+ *.py,cover
61
+ .hypothesis/
62
+ .pytest_cache/
63
+ cover/
64
+
65
+ # Translations
66
+ *.mo
67
+ *.pot
68
+
69
+ # Django stuff:
70
+ *.log
71
+ local_settings.py
72
+ db.sqlite3
73
+ db.sqlite3-journal
74
+
75
+ # Flask stuff:
76
+ instance/
77
+ .webassets-cache
78
+
79
+ # Scrapy stuff:
80
+ .scrapy
81
+
82
+ # Sphinx documentation
83
+ docs/_build/
84
+
85
+ # PyBuilder
86
+ .pybuilder/
87
+ target/
88
+
89
+ # Jupyter Notebook
90
+ .ipynb_checkpoints
91
+
92
+ # IPython
93
+ profile_default/
94
+ ipython_config.py
95
+
96
+ # pyenv
97
+ # For a library or package, you might want to ignore these files since the code is
98
+ # intended to run in multiple environments; otherwise, check them in:
99
+ # .python-version
100
+
101
+ # pipenv
102
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
103
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
104
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
105
+ # install all needed dependencies.
106
+ #Pipfile.lock
107
+
108
+ # poetry
109
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
110
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
111
+ # commonly ignored for libraries.
112
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
113
+ #poetry.lock
114
+
115
+ # pdm
116
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
117
+ #pdm.lock
118
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
119
+ # in version control.
120
+ # https://pdm.fming.dev/#use-with-ide
121
+ .pdm.toml
122
+
123
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
124
+ __pypackages__/
125
+
126
+ # Celery stuff
127
+ celerybeat-schedule
128
+ celerybeat.pid
129
+
130
+ # SageMath parsed files
131
+ *.sage.py
132
+
133
+ # Environments
134
+ .env
135
+ .venv
136
+ env/
137
+ venv/
138
+ ENV/
139
+ env.bak/
140
+ venv.bak/
141
+
142
+ # Spyder project settings
143
+ .spyderproject
144
+ .spyproject
145
+
146
+ # Rope project settings
147
+ .ropeproject
148
+
149
+ # mkdocs documentation
150
+ /site
151
+
152
+ # mypy
153
+ .mypy_cache/
154
+ .dmypy.json
155
+ dmypy.json
156
+
157
+ # Pyre type checker
158
+ .pyre/
159
+
160
+ # pytype static type analyzer
161
+ .pytype/
162
+
163
+ # Cython debug symbols
164
+ cython_debug/
165
+
166
+ # PyCharm
167
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
168
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
169
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
170
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
171
+ .idea/
172
+ *.env
@@ -1 +1 @@
1
- 3.11
1
+ 3.11
@@ -1,29 +1,29 @@
1
- # Python SDK Guide
2
-
3
- This directory contains the Python SDK package published as `marpledata`.
4
-
5
- ## Structure
6
-
7
- - `src/marple/`: package source.
8
- - `src/marple/db/`: Marple DB types and helpers.
9
- - `src/marple/insight.py`: Marple Insight client.
10
- - `tests/`: pytest integration tests.
11
- - `docs/`: Sphinx documentation.
12
- - `pyproject.toml`: package metadata, dependencies, and `uv` dependency groups.
13
- - `uv.lock`: locked Python dependencies.
14
-
15
- ## Commands
16
-
17
- - Run tests with output: `uv run pytest -vs`
18
- - Build docs: `uv run --group docs sphinx-build -b html docs docs/_build/html`
19
- - Build package: `uv build`
20
-
21
- Run commands from `python/` unless a command explicitly says otherwise.
22
-
23
- ## Conventions
24
-
25
- - Use `uv` for dependency, test, build, and docs workflows.
26
- - Keep Python SDK tests in `python/tests/`.
27
- - Integration tests run against live Marple services and may require
28
- `MDB_TOKEN`, `MDB_URL`, `INSIGHT_TOKEN`, and `INSIGHT_URL`. Tests should skip
29
- or fail clearly when required credentials are missing.
1
+ # Python SDK Guide
2
+
3
+ This directory contains the Python SDK package published as `marpledata`.
4
+
5
+ ## Structure
6
+
7
+ - `src/marple/`: package source.
8
+ - `src/marple/db/`: Marple DB types and helpers.
9
+ - `src/marple/insight.py`: Marple Insight client.
10
+ - `tests/`: pytest integration tests.
11
+ - `docs/`: Sphinx documentation.
12
+ - `pyproject.toml`: package metadata, dependencies, and `uv` dependency groups.
13
+ - `uv.lock`: locked Python dependencies.
14
+
15
+ ## Commands
16
+
17
+ - Run tests with output: `uv run pytest -vs`
18
+ - Build docs: `uv run --group docs sphinx-build -b html docs docs/_build/html`
19
+ - Build package: `uv build`
20
+
21
+ Run commands from `python/` unless a command explicitly says otherwise.
22
+
23
+ ## Conventions
24
+
25
+ - Use `uv` for dependency, test, build, and docs workflows.
26
+ - Keep Python SDK tests in `python/tests/`.
27
+ - Integration tests run against live Marple services and may require
28
+ `MDB_TOKEN`, `MDB_URL`, `INSIGHT_TOKEN`, and `INSIGHT_URL`. Tests should skip
29
+ or fail clearly when required credentials are missing.
@@ -1,39 +1,45 @@
1
- # Changelog
2
-
3
- All notable changes to the Python SDK package `marpledata` 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 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
-
8
- ## [3.2.2] - 2026-06-01
9
-
10
- ### Changed
11
-
12
- - Added default request timeouts and bounded retries to improve SDK reliability on spotty networks.
13
- - Retried idempotent direct-storage uploads while keeping Marple API POST retries conservative.
14
-
15
- ## [3.2.1] - 2026-05-22
16
-
17
- ### Changed
18
-
19
- - Included the SDK version in the `X-Request-Source` header sent by the Marple Insight client, matching the Marple DB client.
20
-
21
- ## [3.2.0] - 2026-05-22
22
-
23
- ### Added
24
-
25
- - Added the current Marple DB ingestion flow to `DataStream.push_file`.
26
- - Added automatic upload mode handling for server upload, Azure direct upload, single presigned upload, and multipart upload.
27
- - Added `concurrency` to control parallel direct-storage uploads.
28
- - Added `upload_mode="server"` to force uploads through the Marple DB API server when direct storage URLs are blocked.
29
- - Added `azure-storage-blob` as a runtime dependency for Azure-backed direct uploads.
30
-
31
- ### Changed
32
-
33
- - Updated upload error handling to abort failed ingestions with a reason.
34
- - Undeprecated `DB.delete_stream` and `DB.delete_dataset` convenience methods.
35
- - Expanded README and Sphinx documentation for large-file uploads, forced server uploads, and integration test configuration.
36
-
37
- ### Notes
38
-
39
- - `DB.push_file`, `DB.download_signal`, and `DB.update_metadata` remain deprecated compatibility paths. Prefer `DataStream`, `Dataset`, and `Signal` methods for new code.
1
+ # Changelog
2
+
3
+ All notable changes to the Python SDK package `marpledata` 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 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [3.2.3] - 2026-06-08
9
+
10
+ ### Changed
11
+
12
+ - Bugfix build artifact `insight.py`
13
+
14
+ ## [3.2.2] - 2026-06-01
15
+
16
+ ### Changed
17
+
18
+ - Added default request timeouts and bounded retries to improve SDK reliability on spotty networks.
19
+ - Retried idempotent direct-storage uploads while keeping Marple API POST retries conservative.
20
+
21
+ ## [3.2.1] - 2026-05-22
22
+
23
+ ### Changed
24
+
25
+ - Included the SDK version in the `X-Request-Source` header sent by the Marple Insight client, matching the Marple DB client.
26
+
27
+ ## [3.2.0] - 2026-05-22
28
+
29
+ ### Added
30
+
31
+ - Added the current Marple DB ingestion flow to `DataStream.push_file`.
32
+ - Added automatic upload mode handling for server upload, Azure direct upload, single presigned upload, and multipart upload.
33
+ - Added `concurrency` to control parallel direct-storage uploads.
34
+ - Added `upload_mode="server"` to force uploads through the Marple DB API server when direct storage URLs are blocked.
35
+ - Added `azure-storage-blob` as a runtime dependency for Azure-backed direct uploads.
36
+
37
+ ### Changed
38
+
39
+ - Updated upload error handling to abort failed ingestions with a reason.
40
+ - Undeprecated `DB.delete_stream` and `DB.delete_dataset` convenience methods.
41
+ - Expanded README and Sphinx documentation for large-file uploads, forced server uploads, and integration test configuration.
42
+
43
+ ### Notes
44
+
45
+ - `DB.push_file`, `DB.download_signal`, and `DB.update_metadata` remain deprecated compatibility paths. Prefer `DataStream`, `Dataset`, and `Signal` methods for new code.
@@ -1,76 +1,74 @@
1
- ## Development (Python)
2
-
3
- ### Testing
4
-
5
- The testing suite runs against a real linked DB & Insight deployment on our SaaS (e.g. Castro Comrades).
6
- Among other things it will create a stream, ingest a dataset, and export that dataset from Insight
7
- Upload tests also exercise server and multipart upload flows, and create/delete temporary streams with a test prefix.
8
-
9
- ```bash
10
- export MDB_TOKEN=...
11
- export INSIGHT_TOKEN=...
12
- # Optional, defaults to SaaS URLs:
13
- export MDB_URL=https://db.marpledata.com/api/v1
14
- export INSIGHT_URL=https://insight.marpledata.com/api/v1
15
- uv run pytest -vs
16
- ```
17
-
18
- ### Documentation
19
-
20
- Build the Sphinx docs locally:
21
-
22
- ```bash
23
- uv sync --group docs
24
- uv run sphinx-build -b html docs docs/_build/html
25
- ```
26
-
27
- Open `docs/_build/html/index.html` in your browser to view the site.
28
-
29
- ### Local build
30
-
31
- - `uv build`
32
- - `uv run pip install dist/*.whl` (Install in your local .venv)
33
- - `uv run python`
34
- - `import marple`
35
- - `marple.__version__`
36
- - `from marple import Insight, DB`
37
-
38
- ### Publishing (Test Pypi)
39
-
40
- Only once on your laptop
41
-
42
- - `uv build`
43
- - `uv publish --index testpypi`
44
- - `username: __token__`
45
- - `password: pypi-XXXXXXXXXXXXXXXXXXXXXXXXXXXX` (see 1Password)
46
-
47
- For every build
48
-
49
- - `uv version x.y.z.devi`
50
- - bump version in `__version__` variable
51
- - `uv build`
52
- - `uv publish --index testpypi`
53
-
54
- **Versioning**
55
-
56
- To ensure pip correctly updates our package, correct versioning is important. Use `major.minor.patch`
57
-
58
- - `major` when they make incompatible API changes
59
- - `minor` when they add functionality in a backwards-compatible manner
60
- - `patch` when they make backwards-compatible bug fixes
61
-
62
- **Recommended test workflow**
63
-
64
- - Publish to test Pypi
65
- - Open a docker container with the desired python version: `docker run -it python:3.11-alpine sh`
66
- - Install the test pypi package `pip install --upgrade -i --pre https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple marpledata`
67
- - If you want to publish again, change the version to one that has not been used before. Even if you delete a build via [the UI](https://test.pypi.org/manage/project/marpledata/releases/) you cannot publish that version again. For testing, you could use something like `x.y.z.dev1`, `x.y.z.dev2`, `x.y.z.dev3`, ...
68
-
69
- ### Publishing (real Pypi)
70
-
71
- ⚠ **Impacts users, be careful**
72
-
73
- - check version: `pyproject.toml:version`, `__init__.py:__version__`
74
- - `uv build`
75
- - `uv publish --token pypi-XXXXXXXXXXXXXXXXXXXXXXXXXXXX` (see 1Password)
76
- - Run the GitLab pipeline `pages` to build & release the docs
1
+ ## Development (Python)
2
+
3
+ ### Testing
4
+
5
+ The testing suite runs against a real linked DB & Insight deployment on our SaaS (e.g. Castro Comrades).
6
+ Among other things it will create a stream, ingest a dataset, and export that dataset from Insight
7
+ Upload tests also exercise server and multipart upload flows, and create/delete temporary streams with a test prefix.
8
+
9
+ ```bash
10
+ export MDB_TOKEN=...
11
+ export INSIGHT_TOKEN=...
12
+ # Optional, defaults to SaaS URLs:
13
+ export MDB_URL=https://db.marpledata.com/api/v1
14
+ export INSIGHT_URL=https://insight.marpledata.com/api/v1
15
+ uv run pytest -vs
16
+ ```
17
+
18
+ ### Documentation
19
+
20
+ Build the Sphinx docs locally:
21
+
22
+ ```bash
23
+ uv sync --group docs
24
+ uv run sphinx-build -b html docs docs/_build/html
25
+ ```
26
+
27
+ Open `docs/_build/html/index.html` in your browser to view the site.
28
+
29
+ ### Local build
30
+
31
+ - Bump version
32
+ - Delete `./dist` folder
33
+ - `uv build`
34
+ - `uv run pip install dist/*.whl` (Install in your local .venv)
35
+ - `uv run python`
36
+ - `import marple`
37
+ - `marple.__version__`
38
+ - `from marple import Insight, DB`
39
+
40
+ ### Publishing (Test Pypi)
41
+
42
+ Only once on your laptop
43
+
44
+ - `uv build`
45
+ - `uv publish --index testpypi`
46
+ - `username: __token__`
47
+ - `password: pypi-XXXXXXXXXXXXXXXXXXXXXXXXXXXX` (see 1Password)
48
+
49
+ For every build
50
+
51
+ - `uv version x.y.z.devi`
52
+ - bump version in `__version__` variable
53
+ - `uv build`
54
+ - `uv publish --index testpypi`
55
+
56
+ **Versioning**
57
+
58
+ To ensure pip correctly updates our package, correct versioning is important. Use `major.minor.patch`
59
+
60
+ **Recommended test workflow**
61
+
62
+ - Publish to test Pypi
63
+ - Open a docker container with the desired python version: `docker run -it python:3.11-alpine sh`
64
+ - Install the test pypi package `pip install --upgrade -i --pre https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple marpledata`
65
+ - If you want to publish again, change the version to one that has not been used before. Even if you delete a build via [the UI](https://test.pypi.org/manage/project/marpledata/releases/) you cannot publish that version again. For testing, you could use something like `x.y.z.dev1`, `x.y.z.dev2`, `x.y.z.dev3`, ...
66
+
67
+ ### Publishing (real Pypi)
68
+
69
+ ⚠ **Impacts users, be careful**
70
+
71
+ - check version: `pyproject.toml:version`, `__init__.py:__version__`
72
+ - `uv build`
73
+ - `uv publish --token pypi-XXXXXXXXXXXXXXXXXXXXXXXXXXXX` (see 1Password)
74
+ - Run the GitLab pipeline `pages` to build & release the docs
@@ -1,13 +1,13 @@
1
- Copyright 2022-2026 Marple BV
2
-
3
- Licensed under the Apache License, Version 2.0 (the "License");
4
- you may not use this file except in compliance with the License.
5
- You may obtain a copy of the License at
6
-
7
- http://www.apache.org/licenses/LICENSE-2.0
8
-
9
- Unless required by applicable law or agreed to in writing, software
10
- distributed under the License is distributed on an "AS IS" BASIS,
11
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- See the License for the specific language governing permissions and
13
- limitations under the License.
1
+ Copyright 2022-2026 Marple BV
2
+
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, software
10
+ distributed under the License is distributed on an "AS IS" BASIS,
11
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ See the License for the specific language governing permissions and
13
+ limitations under the License.