wirio-settings 0.0.1__tar.gz

wirio_settings-0.0.1/.github/workflows/ci.yaml

@@ -0,0 +1,272 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "*"
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Lint
+    if: github.actor != 'dependabot[bot]'
+    runs-on: ubuntu-24.04
+    env:
+      UV_NO_SYNC: 1
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+        with:
+          version-file: pyproject.toml
+          resolution-strategy: highest
+
+      - name: Install Python packages
+        run: uv sync --locked --all-extras
+        shell: bash
+
+      - name: Check code
+        run: make check-code
+        shell: bash
+
+  test:
+    name: Test (Python=${{ matrix.python-version }}, Resolution=${{ matrix.resolution-strategy }}, Extra=${{ matrix.extra }})
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: ["3.13", "3.14"]
+        resolution-strategy: ["lowest-direct", "highest"]
+        extra: ["no-extra", "azure-key-vault", "aws-secrets-manager"]
+    env:
+      UV_NO_SYNC: 1
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+        with:
+          version-file: pyproject.toml
+          resolution-strategy: highest
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Python packages
+        run: |
+          uv sync \
+          --resolution ${{ matrix.resolution-strategy }} \
+          ${{ matrix.extra != 'no-extra' && format('--extra {0}', matrix.extra) || '' }}
+        shell: bash
+
+      - name: Install crates
+        run: uv run -- maturin develop --uv
+        shell: bash
+
+      - name: Test
+        run: uv run -- pytest --cov=wirio_settings --cov-branch tests
+        shell: bash
+
+  linux:
+    runs-on: ${{ matrix.platform.runner }}
+    needs: test
+    strategy:
+      matrix:
+        platform:
+          - runner: ubuntu-22.04
+            target: x86_64
+          - runner: ubuntu-22.04
+            target: x86
+          - runner: ubuntu-22.04
+            target: aarch64
+          - runner: ubuntu-22.04
+            target: armv7
+          - runner: ubuntu-22.04
+            target: s390x
+          - runner: ubuntu-22.04
+            target: ppc64le
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Install Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        with:
+          python-version: "3.13"
+
+      - name: Build wheels
+        uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+          manylinux: auto
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: wheels-linux-${{ matrix.platform.target }}
+          path: dist
+
+  musllinux:
+    runs-on: ${{ matrix.platform.runner }}
+    needs: test
+    strategy:
+      matrix:
+        platform:
+          - runner: ubuntu-22.04
+            target: x86_64
+          - runner: ubuntu-22.04
+            target: x86
+          - runner: ubuntu-22.04
+            target: aarch64
+          - runner: ubuntu-22.04
+            target: armv7
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Install Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        with:
+          python-version: "3.13"
+
+      - name: Build wheels
+        uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+          manylinux: musllinux_1_2
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: wheels-musllinux-${{ matrix.platform.target }}
+          path: dist
+
+  windows:
+    runs-on: ${{ matrix.platform.runner }}
+    needs: test
+    strategy:
+      matrix:
+        platform:
+          - runner: windows-latest
+            target: x64
+            python_arch: x64
+          - runner: windows-latest
+            target: x86
+            python_arch: x86
+          - runner: windows-11-arm
+            target: aarch64
+            python_arch: arm64
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Install Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        with:
+          python-version: "3.13"
+          architecture: ${{ matrix.platform.python_arch }}
+
+      - name: Build wheels
+        uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: wheels-windows-${{ matrix.platform.target }}
+          path: dist
+
+  macos:
+    runs-on: ${{ matrix.platform.runner }}
+    needs: test
+    strategy:
+      matrix:
+        platform:
+          - runner: macos-15-intel
+            target: x86_64
+          - runner: macos-latest
+            target: aarch64
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Install Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        with:
+          python-version: "3.13"
+
+      - name: Build wheels
+        uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: wheels-macos-${{ matrix.platform.target }}
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Build sdist
+        uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
+        with:
+          command: sdist
+          args: --out dist
+
+      - name: Upload sdist
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: wheels-sdist
+          path: dist
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }}
+    needs: [linux, musllinux, windows, macos, sdist]
+    environment: release
+    permissions:
+      # Use to sign the release artifacts
+      id-token: write
+      # Used to upload release artifacts
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+        with:
+          version-file: pyproject.toml
+          resolution-strategy: highest
+
+      - name: Publish to PyPI
+        run: uv publish 'wheels-*/*'

wirio_settings-0.0.1/.gitignore

@@ -0,0 +1,16 @@
+debug/
+target/
+**/*.rs.bk
+*.pdb
+*.so
+*.pyc
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+.venv/
+.ruff_cache/
+.pytest_cache/
+.coverage

wirio_settings-0.0.1/Cargo.lock

@@ -0,0 +1,133 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "libc"
+version = "0.2.186"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.28.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "91fd8e38a3b50ed1167fb981cd6fd60147e091784c427b8f7183a7ee32c31c12"
+dependencies = [
+ "libc",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.28.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e368e7ddfdeb98c9bca7f8383be1648fd84ab466bf2bc015e94008db6d35611e"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.28.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7f29e10af80b1f7ccaf7f69eace800a03ecd13e883acfacc1e5d0988605f651e"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.28.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "df6e520eff47c45997d2fc7dd8214b25dd1310918bbb2642156ef66a67f29813"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.28.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c4cdc218d835738f81c2338f822078af45b4afdf8b2e33cbb5916f108b813acb"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "wirio-settings"
+version = "0.0.1"
+dependencies = [
+ "pyo3",
+]

wirio_settings-0.0.1/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "wirio-settings"
+version = "0.0.1"
+edition = "2024"
+readme = "README.md"
+
+[lib]
+name = "_wirio_settings"
+crate-type = ["cdylib"]
+
+[dependencies]
+pyo3 = { version = "0.28.3", features = [
+    "experimental-inspect",
+    "experimental-async",
+] }
+
+[package.metadata.maturin]
+python-source = "python"

wirio_settings-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Andreu Codina
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

wirio_settings-0.0.1/Makefile

@@ -0,0 +1,15 @@
+.PHONY: install
+install:
+	uv sync --all-extras
+
+.PHONY: check-code
+check-code:
+	uv run -- ruff check
+	uv run -- ruff format --diff
+	uv run -- ty check
+
+.PHONY: setup-development
+setup-development:
+	uv run -- maturin develop --generate-stubs --uv
+	uv run -- maturin generate-stubs -o python/wirio_settings
+

wirio_settings-0.0.1/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: wirio-settings
+Version: 0.0.1
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Intended Audience :: Developers
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: boto3[crt]>=1.42.71 ; extra == 'aws-secrets-manager'
+Requires-Dist: aiohttp>=3.13.3 ; extra == 'azure-key-vault'
+Requires-Dist: azure-identity>=1.25.2 ; extra == 'azure-key-vault'
+Requires-Dist: azure-keyvault-secrets>=4.10.0 ; extra == 'azure-key-vault'
+Provides-Extra: aws-secrets-manager
+Provides-Extra: azure-key-vault
+License-File: LICENSE
+Keywords: settings,azure,Azure Key Vault,aws,AWS Secrets Manager
+Requires-Python: >=3.13

wirio_settings-0.0.1/README.md

@@ -0,0 +1,185 @@
+## Overview
+
+Lightning-fast, strongly typed, and zero boilerplate settings library for Python:
+
+- **Great defaults from day one:** It automatically looks for settings files and environment variables, with recommended configurations and zero boilerplate.
+- **Rust-powered core:** Built with Rust under the hood for speed, reliability, and low runtime overhead.
+- **Cloud secrets when we need them:** Azure Key Vault and AWS Secrets Manager integrations are available with one line of code, with safe authentication.
+- **Works naturally with Pydantic models:** Load your app settings directly into models.
+- **Async-ready by design:** Built to work smoothly with modern async Python apps and cloud SDKs.
+- **A practical replacement:** Replace `pydantic-settings` and `python-dotenv` with one unified settings library.
+- **Roadmap:** Planned capabilities include automatic reload on settings changes (events, time, sentinel, async), pluggable configuration stores, feature flags and lifetimes.
+
+## 📦 Installation
+
+```bash
+uv add wirio-settings
+```
+
+## ✨ Quickstart with Pydantic models
+
+```python
+from pydantic import BaseModel
+from wirio_settings import SettingsManager
+
+
+class ApplicationSettings(BaseModel):
+    database_password: str
+
+
+application_settings = SettingsManager().get_model(ApplicationSettings)
+```
+
+## Source priority
+
+`wirio-settings` supports multiple sources. When the same key exists in multiple sources, the last added sources have more priority.
+
+The following sources are loaded, by default, in this order:
+
+1. `settings.yaml`
+2. `settings.{environment}.yaml`.
+3. Environment variables
+
+Considerations:
+
+- Files are optional. If a file is not found, it's skipped.
+- `{environment}` is the value of the `WIRIO_ENVIRONMENT` environment variable. If the variable is not set, its value is `local`. This would load, for example, `settings.production.yaml` if `WIRIO_ENVIRONMENT=production`. It standardizes the environment detection and allows us to store all settings in code, with version control.
+- In the default settings, environment variables have higher priority than YAML files because the source is added after them. This means that if a key exists in both `settings.yaml` and environment variables, the value from environment variables will be used.
+- If we add more sources, those will have higher priority than the defaults. For example, if we add Azure Key Vault as a source, it will override the defaults.
+
+  ```python
+  SettingsManager().add_azure_key_vault("https://example.vault.azure.net/")
+  ```
+
+## Naming convention
+
+Each source (environment variables, YAML, Azure Key Vault...) has its own naming convention for keys. `wirio-settings` uses snake case for settings keys. When loading from sources, keys are normalized to snake case. For example, the `APP_NAME` environment variable maps to `app_name`.
+
+## Recommended usage
+
+It depends on your usage, but the recommended setup is having the following files:
+
+- `settings.yaml` with the shared settings.
+- `settings.{environment}.yaml` with the environment-specific settings. For example, `settings.production.yaml`, `settings.staging.yaml`, `settings.local.yaml`, etc.
+
+Then, we declare the settings manager, loading the default sources:
+
+```python
+settings_manager = SettingsManager()
+```
+
+Now, `settings_manager` has settings loaded.
+
+Let's say our API is deployed in production, so we have read the `key_vault_url` setting from `settings.production.yaml`. We can now add Azure Key Vault as a source and read the rest of the settings from there:
+
+```python
+settings_manager.add_azure_key_vault(
+    settings_manager.get_required_value("key_vault_url")
+)
+```
+
+After that, we have all settings to construct our Pydantic model:
+
+```python
+application_settings = settings_manager.get_model(ApplicationSettings)
+```
+
+## Read one value
+
+- Use `get_required_value` when the key must exist.
+
+```python
+openai_api_key = settings_manager.get_required_value("openai_api_key")
+```
+
+By default, the settings system returns values as strings. To validate and convert to another type, pass the type as a second argument.
+
+```python
+timeout_seconds = settings_manager.get_required_value("maximum_retries", int)
+```
+
+- Use `get_value` for optional keys.
+
+```python
+openai_api_key = settings_manager.get_value("openai_api_key")
+timeout_seconds = settings_manager.get_value("maximum_retries", int)
+```
+
+## Defaults and required fields
+
+If a model field has a default, that default is used when no value is found.
+
+```python
+from pydantic import BaseModel
+
+
+class ApplicationSettings(BaseModel):
+    app_name: str
+    port: int | None = None
+```
+
+Here, `port` defaults to `None` when missing.
+If a required field is missing, `get_model` raises `KeyError`.
+
+## Sections
+
+Use `get_section` to read a section. For example, we can read the next YAML:
+
+```yaml
+logging:
+  log_level: WARNING
+```
+
+```python
+log_level = settings_manager.get_section("logging").get_required_value(
+    "log_level"
+)
+```
+
+`SettingsSection` supports:
+
+- The section value itself with `section.get_required_value()` or `section.get_required_value(type)`.
+- A child value with `section.get_required_value("child.key")` or `section.get_required_value("child.key", type)`.
+
+If a section has only children and no value at its own path, `section.get_value()` returns `None`.
+
+## Nested keys
+
+Nested keys use `.`:
+
+- `database.host`
+- `database.port`
+- `logging.log_level.default`
+
+## Other sources
+
+### Azure Key Vault
+
+```bash
+uv add wirio-settings[azure-key-vault]
+```
+
+1. Add Key Vault as a source:
+
+```python
+settings_manager.add_azure_key_vault(
+    "https://example.vault.azure.net",
+)
+```
+
+If no credential is provided, `DefaultAzureCredential` is used.
+We can also pass a custom async Azure credential with the `credential` parameter.
+
+## AWS Secrets Manager
+
+```bash
+uv add wirio-settings[aws-secrets-manager]
+```
+
+```python
+settings_manager.add_aws_secrets_manager(
+    "SecretName"
+)
+```
+
+The secret value must be a JSON object. `wirio-settings` reads and flattens that JSON into settings keys.