mpt-tool 5.0.0__tar.gz

mpt_tool-5.0.0/.gitignore

@@ -0,0 +1,173 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+out.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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+.devcontainer/
+.vscode
+
+.DS_Store
+.ruff_cache
+.idea
+
+# Specific project gitignore
+migrations/
+.migrations-state.json
+settings.py

mpt_tool-5.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mpt_tool-5.0.0/PKG-INFO

@@ -0,0 +1,299 @@
+Metadata-Version: 2.4
+Name: mpt-tool
+Version: 5.0.0
+Summary: Migration tool for extensions
+Author: SoftwareOne AG
+License: Apache-2.0 license
+License-File: LICENSE
+Requires-Python: <4,>=3.12
+Requires-Dist: mpt-api-client==5.0.*
+Requires-Dist: pyairtable==3.3.*
+Requires-Dist: typer>=0.9.0
+Description-Content-Type: text/markdown
+
+# mpt-tool CLI
+
+mpt-tool is a command-line utility to scaffold, run, and audit migrations for MPT extensions.
+
+## Quick Start
+1. **Install the tool:**
+    ```bash
+      pip install mpt-tool
+    ```
+2. **Create your first migration:**
+    ```bash
+      mpt-tool migrate --new-data sync_users
+    ```
+3. **Edit the generated file in the migrations/ folder**
+4. **Run all pending migrations**
+    ```bash
+      mpt-tool migrate --data
+    ```
+
+## Installation
+
+Install with pip or your favorite PyPI package manager:
+
+```bash
+  pip install mpt-tool
+```
+
+```bash
+  uv add mpt-tool
+```
+
+## Prerequisites
+
+- Python 3.12+ in your environment
+- A `migrations/` folder in your project (it will be created automatically the first time you create a migration)
+- Environment variables. See [Environment Variables](#environment-variables) for details.
+
+## Environment Variables
+
+The tool uses the following environment variables:
+- `STORAGE_TYPE`: Storage backend for migration state (`local` or `airtable`, default: `local`). See [Storage Configuration](#storage)
+- `MPT_API_TOKEN`: Your MPT API key (required when using `MPTAPIClientMixin`)
+- `MPT_API_BASE_URL`: The MPT API base url (required when using `MPTAPIClientMixin`)
+- `AIRTABLE_API_KEY`: Your Airtable API key (required when using `AirtableAPIClientMixin` or when `STORAGE_TYPE=airtable`)
+
+## Configuration
+
+### Storage
+
+The tool supports two storage backends: local and Airtable. By default, it uses the local storage.
+
+Local storage is the simplest option and is suitable for development and testing. However, it is not suitable for production deployments.
+The state is stored in a `.migrations-state.json` file in your project root.
+
+Airtable storage is recommended for production deployments. It allows you to track migration progress across multiple deployments.
+
+#### Local Storage
+No additional configuration is required.
+
+#### Airtable Storage
+
+Airtable configuration is done via environment variables:
+- `AIRTABLE_API_KEY`: Your Airtable API key
+- `STORAGE_AIRTABLE_BASE_ID`: Your Airtable base ID
+- `STORAGE_AIRTABLE_TABLE_NAME`: The name of the table to store migration state
+
+Your Airtable table must have the following columns:
+
+| Column Name   | Field Type                  | Required |
+|---------------|-----------------------------|:--------:|
+| order_id      | number                      |    ✅     |
+| migration_id  | singleLineText              |    ✅     |
+| started_at    | dateTime                    |    ❌     |
+| applied_at    | dateTime                    |    ❌     |
+| type          | singleSelect (data, schema) |    ✅     |
+
+
+**Airtable configuration steps:**
+1. Create a new table in your Airtable base (or use an existing one)
+2. Add the columns listed above with the specified field types
+3. Set the environment variables with your base ID and table name
+
+## Usage
+
+### Creating a New Migration
+1. Decide the migration type (**data** or **schema**).
+   - **Data**: run after a release is deployed. Can take hours or days. Executed while MPT is running (e.g., updating product parameters, synchronizing Assets with external data)
+   - **Schema**: run before a release is deployed. Must be fast (not more than 15 min). Executed without ensuring the MPT is running (e.g., adding columns in Airtable)
+2. Run the appropriate command:
+```bash
+  # Data migration
+  mpt-tool migrate --new-data "migration_name"
+```
+```bash
+  # Schema migration
+  mpt-tool migrate --new-schema "migration_name"
+```
+
+A new file is created in `migrations/` with a timestamped prefix (e.g., `20260113180013_migration_name.py`) and a prefilled `Command` class.
+
+order_id: timestamp prefix (e.g., `20260113180013`)
+migration_id: user-provided name (e.g., `migration_name`)
+file: generated file name (e.g., `20260113180013_migration_name.py`)
+
+**Generated file structure:**
+
+```python
+from mpt_tool.migration import DataBaseMigration  # or SchemaBaseMigration
+
+
+class Migration(DataBaseMigration):
+    def run(self):
+        # implement your logic here
+        pass
+```
+
+#### Using Mixins
+You can add mixins to your migration commands to access external services:
+
+```python
+from mpt_tool.migration import DataBaseMigration
+from mpt_tool.migration.mixins import MPTAPIClientMixin, AirtableAPIClientMixin
+
+
+class Migration(DataBaseMigration, MPTAPIClientMixin, AirtableAPIClientMixin):
+    def run(self):
+        # Access MPT API
+        agreement = self.mpt_client.commerce.agreements.get("AGR-1234-5678-9012")
+        self.log.info(f"Agreement id: {agreement.id}")
+
+        # Access Airtable
+        table = self.airtable_client.table("app_id", "table_name")
+        records = table.all()
+
+        self.log.info(f"Processed {len(records)} records")
+```
+
+### Running Migrations
+- **Run all pending data migrations:**
+  ```bash
+  mpt-tool migrate --data
+  ```
+- **Run all pending schema migrations:**
+  ```bash
+  mpt-tool migrate --schema
+  ```
+
+Migrations are executed in order based on their order_id (timestamp). The tool automatically:
+- Validates the migration folder structure
+- Skips migrations that have already been applied (applied_at is not null)
+- Tracks execution status in the state storage (`.migrations-state.json` or Airtable table)
+- Logs migration progress
+- Handles errors gracefully and updates state accordingly
+
+**Migration State File (`.migrations-state.json`):**
+```json
+{
+  "data_example": {
+    "migration_id": "data_example",
+    "order_id": 20260113180013,
+    "started_at": "2026-01-13T18:05:20.000000",
+    "applied_at": "2026-01-13T18:05:23.123456",
+    "type": "data"
+  },
+  "schema_example": {
+    "migration_id": "schema_example",
+    "order_id": 20260214121033,
+    "started_at": null,
+    "applied_at": null,
+    "type": "schema"
+  }
+}
+```
+**Migration Table (Airtable):**
+
+| order_id       | migration_id   | started_at                 | applied_at                 | type   |
+|----------------|----------------|----------------------------|----------------------------|--------|
+| 20260113180013 | data_example   | 2026-01-13T18:05:20.000000 | 2026-01-13T18:05:23.123456 | data   |
+| 20260214121033 | schema_example |                            |                            | schema |
+
+
+If a migration succeeds during execution:
+* The started_at timestamp is recorded
+* The applied_at timestamp is recorded
+
+If a migration fails during execution:
+* The started_at timestamp is recorded
+* The applied_at field remains null
+* The error is logged
+* Later runs will retry the failed migration as applied_at is null, unless `--fake` is used to mark it as applied
+
+
+### Fake Mode
+To mark a migration as applied without running it:
+
+```bash
+  mpt-tool migrate --fake MIGRATION_ID
+```
+
+Where `MIGRATION_ID` is the filename without `order_id` and `.py` (e.g., `test1`).
+
+**Example:**
+- File: `20260113180013_sync_users.py`
+- Migration ID: `sync_users`
+
+If the migration doesn't exist in the migrations folder:
+* An error is logged and the command exits
+
+If the migration exists:
+* The migration state is created if it doesn't exist yet or updated:
+  * The started_at field is set as null
+  * The applied_at timestamp is recorded
+
+### Listing Migrations
+To see all migrations and their status:
+
+```bash
+  mpt-tool migrate --list
+```
+
+The output shows execution order, status, and timestamps.
+
+The status column is derived from the persisted timestamps:
+
+| Status      | Condition                                                     |
+|-------------|---------------------------------------------------------------|
+| running     | `started_at` is set and `applied_at` is empty                 |
+| failed      | `started_at` and `applied_at` are empty for an existing state |
+| faked       | `started_at` is empty and `applied_at` is set                 |
+| applied     | Both `started_at` and `applied_at` are set                    |
+| not applied | No state entry exists for the migration file                  |
+
+### Getting Help
+Run `mpt-tool --help` to see all available commands and params:
+```bash
+  mpt-tool --help
+  mpt-tool migrate --help
+```
+
+
+## Best Practices
+
+### Migration Naming
+- Use descriptive, snake_case names (e.g., `add_user_table`, `fix_null_emails`, `sync_agreements_from_api`)
+- Keep names concise but meaningful
+- Avoid generic names like `migration1`, `fix_bug`, or `update`
+
+### Version Control
+- Never modify a migration that has been applied in production
+- Create a new migration to fix issues from a previous one
+
+
+## Troubleshooting
+
+### Common Issues
+
+**Migrations not detected:**
+- Ensure files are in the `migrations/` folder
+- Verify filename follows the pattern: `<timestamp>_<migration_id>.py` (e.g., `20260121120000_migration_name.py`)
+
+**Migration fails to run:**
+- Review the error message in the terminal output
+- Check your `Migration.run()` implementation for syntax errors
+- Fix the issue and re-run the migration or use `--fake` to mark it as applied
+
+**NOTE:** There is currently no automatic rollback mechanism. If a migration partially modifies data before failing, you must manually revert those changes or create a new migration to fix the state.
+
+**Mixin errors (ValueError):**
+- Verify all required environment variables are set
+- Check variable names match exactly (case-sensitive)
+
+**Duplicate migration IDs:**
+- The tool prevents duplicate migration IDs automatically
+- If you see this error, check for files with the same name in the `migrations/` folder
+- Delete or rename the duplicate file
+
+**Migration already applied:**
+- If you need to re-run a migration, either:
+  - Remove its entry from the state storage (use with caution)
+  - Create a new migration with the updated logic
+- Never modify an already-applied migration in production
+
+
+## Development
+
+For development purposes, please, check the Readme in the GitHub repository.