toml-combine 0.1.4__tar.gz

toml_combine-0.1.4/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+Closes #<ticket number>
+
+### Successful PR Checklist:
+
+- [ ] Tests
+  - [ ] (not applicable?)
+- [ ] Documentation
+  - [ ] (not applicable?)

toml_combine-0.1.4/.github/renovate.json5

@@ -0,0 +1,16 @@
+{
+  extends: ["config:recommended", ":enablePreCommit"],
+  schedule: ["before 4am on Saturday"],
+  lockFileMaintenance: {
+    enabled: true,
+    automerge: true,
+  },
+  packageRules: [
+    {
+      groupName: "all dependencies",
+      groupSlug: "all",
+      matchPackageNames: ["*"],
+    },
+  ],
+  automerge: true,
+}

toml_combine-0.1.4/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - "main"
+    tags:
+      - "*"
+
+env:
+  UV_FROZEN: "true"
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+
+    name: "py${{ matrix.python-version }}"
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@f94ec6bedd8674c4426838e6b50417d36b6ab231 # v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run tests
+        run: uv run pytest
+
+  publish:
+    name: Publish package to PyPI
+    if: github.event_name == 'push' && github.ref_type == 'tag'
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    needs:
+      - tests
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 1
+          fetch-tags: true
+          ref: ${{ github.ref }}
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@f94ec6bedd8674c4426838e6b50417d36b6ab231 # v5
+
+      - name: Build wheel & sdist
+        run: uv build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

toml_combine-0.1.4/.github/workflows/coverage-comment.yml

@@ -0,0 +1,21 @@
+name: Post coverage comment
+
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types:
+      - completed
+
+jobs:
+  test:
+    name: Run tests & display coverage
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    steps:
+      # DO NOT run actions/checkout@v2 here, for securitity reasons
+      # For details, refer to https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
+      - name: Post comment
+        uses: ewjoachim/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}

toml_combine-0.1.4/.github/workflows/pr-labels.yml

@@ -0,0 +1,42 @@
+name: Label PR
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+      - edited
+
+jobs:
+  label:
+    name: Label PR
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - run: |
+          export LABELS=$(gh repo view $REPO --json="labels" --jq='.labels[].name | select(startswith(env.PREFIX))')
+          python <(cat <<EOF
+          import sys, os
+          from urllib.parse import quote
+          url = f"https://github.com/{os.environ['REPO']}/labels/"
+          labels = os.environ['LABELS'].strip().splitlines()
+          prefix = os.environ['PREFIX']
+          checked = "- [x] "
+          unchecked = "- [ ] "
+          for line in os.environ["BODY"].splitlines():
+            for label in labels:
+              if label.startswith(prefix) and line.strip().endswith(url + quote(label)):
+                if line.strip().startswith(checked):
+                  print(f"--add-label={label}")
+                elif line.strip().startswith(unchecked):
+                  print(f"--remove-label={label}")
+          EOF
+          ) | xargs --no-run-if-empty --delimiter '\n' gh pr --repo $REPO edit $NUMBER
+
+        env:
+          PREFIX: "PR type: "
+          REPO: procrastinate-org/procrastinate
+          BODY: ${{github.event.pull_request.body}}
+          NUMBER: ${{ github.event.pull_request.number }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

toml_combine-0.1.4/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+ci:
+  autoupdate_schedule: quarterly
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      # File names
+      - id: check-case-conflict
+      # File formats
+      - id: pretty-format-json
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+      # Git shenanigans
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      # Python issues
+      - id: check-ast
+      - id: debug-statements
+      # Whitespace
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.6.12
+    hooks:
+      - id: uv-lock
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.0
+    hooks:
+      - id: ruff
+        args: [--fix, --unsafe-fixes, --show-fixes]
+      - id: ruff-format

toml_combine-0.1.4/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.4
+Name: toml-combine
+Version: 0.1.4
+Summary: A tool for combining complex configurations in TOML format.
+Author-email: Joachim Jablon <ewjoachim@gmail.com>
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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
+Requires-Python: >=3.9
+Requires-Dist: tomli>=2.2.1
+Description-Content-Type: text/markdown
+
+# Toml-combine
+
+`toml-combine` is a Python lib and CLI-tool that reads a toml configuration defining
+a default configuration and overrides with, and applies those overrides to get
+final configurations. Say: you have multiple services, and environments, and you
+want to describe them all without repeating the parts that are common to everyone.
+
+## Concepts
+
+### The config file
+
+The configuration file is usually a TOML file. Here's a small example:
+
+```toml
+[dimensions]
+environment = ["production", "staging"]
+
+[[output]]
+environment = "production"
+
+[[output]]
+environment = "staging"
+
+[default]
+name = "my-service"
+registry = "gcr.io/my-project/"
+container.image_name = "my-image"
+container.port = 8080
+service_account = "my-service-account"
+
+[[override]]
+when.environment = "staging"
+service_account = "my-staging-service-account"
+```
+
+### Dimensions
+
+Consider all the configurations you want to generate. Each one differs from the others.
+Dimensions lets you describe the main "thing" that makes manifests differents, e.g.:
+`environment` might be `staging` or `production`, region might be `eu` or `us`, and
+service might be `frontend` or `backend`. Some combinations of dimensions might not
+exists, for example, maybe there's no `staging` in `eu`.
+
+### Outputs
+
+Create a `output` for each configuration you want to generate, and specify the
+dimensions relevant for this output. It's ok to omit some dimensions when they're not
+used for a given output.
+
+> [!Note]
+> Defining a list as the value of one or more dimensions in a output
+> is a shorthand for defining all combinations of dimensions
+
+### Default
+
+The common configuration to start from, before we start overlaying overrides on top.
+
+### Overrides
+
+Overrides define a set of condition where they apply (`when.<dimension> =
+"<value>"`) and the values that are overriden. Overrides are applied in order from less
+specific to more specific, each one overriding the values of the previous ones:
+
+- If an override contains conditions on more dimensions than another one, it's applied
+  later
+- In case 2 overrides contain the same number of dimensions and they're a disjoint set,
+  then it depends on how the dimensions are defined at the top of the file: dimensions
+  defined last have a greater priority
+
+> [!Note]
+> Defining a list as the value of one or more conditions in an override
+> means that the override will apply to any of the dimension values of the list
+
+### The configuration itself
+
+Under the layer of `dimensions/output/default/override` system, what you actually define
+in the configuration is completely up to you. That said, only nested
+"dictionnaries"/"objects"/"tables"/"mapping" (those are all the same things in
+Python/JS/Toml lingo) will be merged between the default and the overrides, while
+arrays will just replace one another. See `Arrays` below.
+
+In the generated configuration, the dimensions of the output will appear in the generated
+object as an object under the `dimensions` key.
+
+### Arrays
+
+Let's look at an example:
+
+```toml
+[dimensions]
+environment = ["production", "staging"]
+
+[[output]]
+environment = ["production", "staging"]
+
+[default]
+fruits = [{name="apple", color="red"}]
+
+[[override]]
+when.environment = "staging"
+fruits = [{name="orange", color="orange"}]
+```
+
+In this example, on staging, `fruits` is `[{name="orange", color="orange"}]` and not `[{name="apple", color="red"}, {name="orange", color="orange"}]`.
+The only way to get multiple values to be merged is if they are tables: you'll need
+to chose an element to become the key:
+
+```toml
+[dimensions]
+environment = ["production", "staging"]
+
+[[output]]
+environment = ["production", "staging"]
+
+[default]
+fruits.apple.color = "red"
+
+[[override]]
+when.environment = "staging"
+fruits.orange.color = "orange"
+```
+
+In this example, on staging, `fruits` is `{apple={color="red"}, orange={color="orange"}}`.
+
+This example is simple because `name` is a natural choice for the key. In some cases,
+the choice is less natural, but you can always decide to name the elements of your
+list and use that name as a key. Also, yes, you'll loose ordering.
+
+### A bigger example
+
+```toml
+[dimensions]
+environment = ["production", "staging", "dev"]
+service = ["frontend", "backend"]
+
+# All 4 combinations of those values will exist
+[[output]]
+environment = ["production", "staging"]
+service = ["frontend", "backend"]
+
+# On dev, the "service" is not defined. That's ok.
+[[output]]
+environment = "dev"
+
+[default]
+registry = "gcr.io/my-project/"
+service_account = "my-service-account"
+
+[[override]]
+when.service = "frontend"
+name = "service-frontend"
+container.image_name = "my-image-frontend"
+
+[[override]]
+when.service = "backend"
+name = "service-backend"
+container.image_name = "my-image-backend"
+container.port = 8080
+
+[[override]]
+name = "service-dev"
+when.environment = "dev"
+container.env.DEBUG = true
+```
+
+### CLI
+
+```console
+$ toml-combine {path/to/config.toml}
+```
+
+Generates all the outputs described by the given TOML config.
+
+Note that you can restrict generation to some dimension values by passing
+`--{dimension}={value}`
+
+## Lib
+
+```python
+import toml_combine
+
+
+result = toml_combine.combine(
+        config_file=config_file,
+        environment=["production", "staging"],
+        type="job",
+        job=["manage", "special-command"],
+    )
+
+print(result)
+```

toml_combine-0.1.4/README.md

@@ -0,0 +1,191 @@
+# Toml-combine
+
+`toml-combine` is a Python lib and CLI-tool that reads a toml configuration defining
+a default configuration and overrides with, and applies those overrides to get
+final configurations. Say: you have multiple services, and environments, and you
+want to describe them all without repeating the parts that are common to everyone.
+
+## Concepts
+
+### The config file
+
+The configuration file is usually a TOML file. Here's a small example:
+
+```toml
+[dimensions]
+environment = ["production", "staging"]
+
+[[output]]
+environment = "production"
+
+[[output]]
+environment = "staging"
+
+[default]
+name = "my-service"
+registry = "gcr.io/my-project/"
+container.image_name = "my-image"
+container.port = 8080
+service_account = "my-service-account"
+
+[[override]]
+when.environment = "staging"
+service_account = "my-staging-service-account"
+```
+
+### Dimensions
+
+Consider all the configurations you want to generate. Each one differs from the others.
+Dimensions lets you describe the main "thing" that makes manifests differents, e.g.:
+`environment` might be `staging` or `production`, region might be `eu` or `us`, and
+service might be `frontend` or `backend`. Some combinations of dimensions might not
+exists, for example, maybe there's no `staging` in `eu`.
+
+### Outputs
+
+Create a `output` for each configuration you want to generate, and specify the
+dimensions relevant for this output. It's ok to omit some dimensions when they're not
+used for a given output.
+
+> [!Note]
+> Defining a list as the value of one or more dimensions in a output
+> is a shorthand for defining all combinations of dimensions
+
+### Default
+
+The common configuration to start from, before we start overlaying overrides on top.
+
+### Overrides
+
+Overrides define a set of condition where they apply (`when.<dimension> =
+"<value>"`) and the values that are overriden. Overrides are applied in order from less
+specific to more specific, each one overriding the values of the previous ones:
+
+- If an override contains conditions on more dimensions than another one, it's applied
+  later
+- In case 2 overrides contain the same number of dimensions and they're a disjoint set,
+  then it depends on how the dimensions are defined at the top of the file: dimensions
+  defined last have a greater priority
+
+> [!Note]
+> Defining a list as the value of one or more conditions in an override
+> means that the override will apply to any of the dimension values of the list
+
+### The configuration itself
+
+Under the layer of `dimensions/output/default/override` system, what you actually define
+in the configuration is completely up to you. That said, only nested
+"dictionnaries"/"objects"/"tables"/"mapping" (those are all the same things in
+Python/JS/Toml lingo) will be merged between the default and the overrides, while
+arrays will just replace one another. See `Arrays` below.
+
+In the generated configuration, the dimensions of the output will appear in the generated
+object as an object under the `dimensions` key.
+
+### Arrays
+
+Let's look at an example:
+
+```toml
+[dimensions]
+environment = ["production", "staging"]
+
+[[output]]
+environment = ["production", "staging"]
+
+[default]
+fruits = [{name="apple", color="red"}]
+
+[[override]]
+when.environment = "staging"
+fruits = [{name="orange", color="orange"}]
+```
+
+In this example, on staging, `fruits` is `[{name="orange", color="orange"}]` and not `[{name="apple", color="red"}, {name="orange", color="orange"}]`.
+The only way to get multiple values to be merged is if they are tables: you'll need
+to chose an element to become the key:
+
+```toml
+[dimensions]
+environment = ["production", "staging"]
+
+[[output]]
+environment = ["production", "staging"]
+
+[default]
+fruits.apple.color = "red"
+
+[[override]]
+when.environment = "staging"
+fruits.orange.color = "orange"
+```
+
+In this example, on staging, `fruits` is `{apple={color="red"}, orange={color="orange"}}`.
+
+This example is simple because `name` is a natural choice for the key. In some cases,
+the choice is less natural, but you can always decide to name the elements of your
+list and use that name as a key. Also, yes, you'll loose ordering.
+
+### A bigger example
+
+```toml
+[dimensions]
+environment = ["production", "staging", "dev"]
+service = ["frontend", "backend"]
+
+# All 4 combinations of those values will exist
+[[output]]
+environment = ["production", "staging"]
+service = ["frontend", "backend"]
+
+# On dev, the "service" is not defined. That's ok.
+[[output]]
+environment = "dev"
+
+[default]
+registry = "gcr.io/my-project/"
+service_account = "my-service-account"
+
+[[override]]
+when.service = "frontend"
+name = "service-frontend"
+container.image_name = "my-image-frontend"
+
+[[override]]
+when.service = "backend"
+name = "service-backend"
+container.image_name = "my-image-backend"
+container.port = 8080
+
+[[override]]
+name = "service-dev"
+when.environment = "dev"
+container.env.DEBUG = true
+```
+
+### CLI
+
+```console
+$ toml-combine {path/to/config.toml}
+```
+
+Generates all the outputs described by the given TOML config.
+
+Note that you can restrict generation to some dimension values by passing
+`--{dimension}={value}`
+
+## Lib
+
+```python
+import toml_combine
+
+
+result = toml_combine.combine(
+        config_file=config_file,
+        environment=["production", "staging"],
+        type="job",
+        job=["manage", "special-command"],
+    )
+
+print(result)
+```

toml_combine-0.1.4/pyproject.toml

@@ -0,0 +1,79 @@
+[build-system]
+requires = ["hatchling", "uv-dynamic-versioning"]
+build-backend = "hatchling.build"
+
+
+[tool.uv-dynamic-versioning]
+pattern = "default-unprefixed"
+
+[tool.hatch.version]
+source = "uv-dynamic-versioning"
+
+[tool.hatch.build.targets.sdist]
+
+[tool.hatch.build.targets.wheel]
+
+[project]
+name = "toml-combine"
+dynamic = ["version"]
+description = "A tool for combining complex configurations in TOML format."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [{ name = "Joachim Jablon", email = "ewjoachim@gmail.com" }]
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "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",
+]
+
+dependencies = ["tomli>=2.2.1"]
+
+[tool.uv]
+default-groups = ["test"]
+
+[dependency-groups]
+test = ["pytest>=8.3.5"]
+
+[project.scripts]
+toml-combine = "toml_combine.cli:run_cli"
+
+[tool.pytest.ini_options]
+addopts = ["-vv", "--strict-markers", "-rfE"]
+
+[tool.ruff]
+unsafe-fixes = true
+
+[tool.ruff.lint]
+# Enable ruff features:
+# E  => pycodestyle (errors), enabled in ruff default configuration
+# W  => pycodestyle (warnings)
+# F  => pyflakes, enabled in ruff default configuration
+# I  => isort
+# UP => pyupgrade
+# PL => pylint
+select = ["UP", "E", "F", "W", "PL", "I", "TID"]
+ignore = [
+    "E501",    # "Line too long"
+    "E402",    # "Module level import not at top of file"
+    "PLR2004", # "Magic value used in comparison"
+    "PLR0913", # "Too many arguments to function call"
+    "PLR0911", # "Too many return statements"
+    "PLR0912", # "Too many branches"
+    "PLR0915", # "Too many statements"
+    "PLW2901", # "Redefined loop name"
+    "PLR5501", # "Use elif instead of if"
+    "PLW0603", # "Global statement"
+    "PLW1508", # "Invalid-envvar-default"
+]
+
+# Ruff isort specific options
+[tool.ruff.lint.isort]
+required-imports = ["from __future__ import annotations"]