settingspec 0.1.1__py3-none-win32.whl

settingspec-0.1.1.dist-info/METADATA

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: settingspec
+Version: 0.1.1
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Summary: One file for all environments, all languages, all submodules.
+Keywords: configuration,settings,secrets,cli,command-line
+Author: Arijit Basu <settingspec@arijitbasu.in>
+Author-email: Arijit Basu <settingspec@arijitbasu.in>
+License: MIT OR Apache-2.0
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Source Code, https://github.com/sayanarijit/settingspec
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://s15.gifyu.com/images/buXVO.png">
+    <source media="(prefers-color-scheme: light)" srcset="https://s15.gifyu.com/images/buXZJ.png">
+    <img alt="The settingspec cover" width="600" src="https://s15.gifyu.com/images/buXZJ.png">
+  </picture>
+</p>
+
+[![SettingSpec Check](https://github.com/sayanarijit/settingspec/actions/workflows/settingspec-check.yml/badge.svg)](https://github.com/sayanarijit/settingspec/actions/workflows/settingspec-check.yml)
+[![Crates.io Version](https://img.shields.io/crates/v/settingspec)](https://crates.io/crates/settingspec)
+[![PyPI Version](https://img.shields.io/pypi/v/settingspec)](https://pypi.org/project/settingspec)
+[![NPM Version](https://img.shields.io/npm/v/%40sayanarijit%2Fsettingspec)](https://www.npmjs.com/package/@sayanarijit/settingspec)
+
+1. [Concepts](#concepts)
+   1. [Single file convenience](#single-file-convenience)
+   2. [Declarative profiles / environments](#declarative-profiles-/-environments)
+   3. [Language independent](#language-independent)
+   4. [Easy secrets](#easy-secrets)
+      1. [SecretSpec](#secretspec)
+      2. [Dotenv](#dotenv)
+2. [Learn more](#learn-more)
+
+## Concepts
+
+### Single file convenience
+
+With a single source of truth, i.e., `settingspec.toml`, you don't need to mentally merge settings from multiple files, say `common.toml`, `dev.toml`, `prod.toml`, etc. No surprise overwrites. One file for all environments, all languages, all submodules.
+
+### Declarative profiles / environments
+
+```toml
+[spec]                               # Optional: Declare the specification here
+profile.key = "SETTINGSPEC_PROFILE"  # Default: Environment variable name to switch between profiles
+profile.options = [                  # Optional: Enables strict checking of per-profile declarations
+  "dev",
+  "stage",
+  "prod",
+]
+profile.default = "dev"  # Optional: Default profile when the switch is not set
+
+[settings]                 # Declare the settings here with syntax: `<key>.<profile>.<directive> = <value>`
+key1.default.val = "val1"  # Default value for all profiles
+key1.prod.val = "prod1"    # Override the default value when SETTINGSPEC_PROFILE=prod
+
+# Strictly define different values for different profiles
+key2.dev.val = "dev2"      # When SETTINGSPEC_PROFILE=dev, key2=dev2
+key2.stage.val = "stage2"
+key2.prod.val = "prod2"
+```
+
+Overrides are intentional and kept in plain sight (see `key1`).
+
+By not defining a default value, you can ensure that you never miss adding a value for a specific profile (e.g. this file will refuse to load if `key2.prod` declaration is missing).
+
+### Language independent
+
+The command-line tool `settingspec` can export the final settings into well-known formats such as `toml`, `json`, `yaml`, etc., or hard-coded modules such as `.py`, `.js`, `.lua`, etc., write them to disk, print, or pipe them via stdin or even export as environment variables, allowing you to use a single `settingspec.toml` without worrying about the target language.
+
+```toml
+[spec]
+export.file = true             # Default: Export all settings into settings.toml (or specify fine-grained file map)
+# export.file = {              # Optional: Fine-grained control over what to export
+#   "settings.json" = true,
+#   "settings.yaml" = {
+#     key1 = true,
+#     group1 = true,
+#     group2.subgroup = true,
+#     group3.subgroup.key1 = false,
+#     "#tag1" = true,
+#   },
+# }
+export.skip_gitignore = false  # Default: Auto-append exported files to .gitignore if inside a git repo
+export.mode = 0x600     # Default: File permission mode for the exported files
+export.keep = false     # Default: Cleanup the exported files after the program exits
+export.stdout = "toml"  # Optional: Print in toml format
+export.env = "PREFIX_"  # Optional: Export as environment variables prefixed with this string
+export.stdin = "toml"   # Optional: Pass settings to program stdin in specified format
+
+[settings]
+key1.default.val = "val1"
+group1.key1.default.val = "group1val1"
+group2.subgroup.key1.default.val = "group2val1"
+group3.subgroup.key1.default.val = "group3val1"
+group3.subgroup.key1.default.tags = ["tag1", "tag2"]
+```
+
+Now export the final settings as declared.
+
+```bash
+settingspec export
+```
+
+Or directly run the program with exported settings.
+
+```bash
+settingspec run -- [your program]...
+```
+
+If no export option is specified, the default behavior is to export all settings into `settings.toml`.
+
+> [!NOTE]
+> If the target programming language supports null values, you can declare it as `key.default.null = true` in the settings section.
+
+### Easy secrets
+
+Unlike regular settings, secrets aren't supposed to be easily visible. So, they are best declared inside hidden/encrypted files and passed via environment variables or via stdin.
+
+However, with SettingSpec, we can ensure that they are actually set and also include them in the final exported settings.
+
+#### SecretSpec
+
+You can pair up SettingSpec with a declarative secrets manager such as [SecretSpec](https://secretspec.dev).
+
+secretspec.toml
+
+```toml
+[project]
+name = "my-app"
+revision = "1.0"
+
+[profiles.default]
+SECRET1 = { description = "Secret One", required = true }
+SECRET2 = { description = "Secret Two", required = false }
+```
+
+settingspec.toml
+
+```toml
+[spec]
+profile.options = ["dev", "stage", "prod"]
+
+[settings]
+secret1.default.env = "SECRET1"  # Load value from $SECRET1
+
+# Override the default value from environment variables
+secret2.default.val = "defaultvalue"  # Default value if $SECRET2 is not set
+secret2.default.env = "SECRET2"       # Load value from $SECRET2 if set
+secret2.prod.env = "PRODSECRET"       # Load value from $PRODSECRET if SETTINGSPEC_PROFILE=prod
+```
+
+With these set up, run:
+
+```bash
+secretspec run -- settingspec run -- [your program]...
+```
+
+#### Dotenv
+
+Or keep things simple with [Dotenv](https://www.dotenv.org).
+
+```toml
+[spec]
+profile.options = ["dev", "stage", "prod"]
+
+envfile.default = ".env"  # Load environment variables from this file for all profiles
+envfile.prod = "-"        # Load environment variables from stdin when SETTINGSPEC_PROFILE=prod
+
+[settings]
+secret1.default.env = "SECRET1"     # Load value from $SECRET1
+```
+
+## Learn more
+
+Check out the [settingspec.toml](./settingspec.toml) example file and [full specification](./SPECIFICATION.md) for more details.
+

settingspec-0.1.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+settingspec-0.1.1.data/scripts/settingspec.exe,sha256=Tuw3YWyVX636cp_80ervZudNSQ0o8upDZKvwuRxXUFE,1006080
+settingspec-0.1.1.dist-info/METADATA,sha256=scxKQHaziOMSNTtKpko1vF2yFLdW3dXVRt0-psFRC9U,7242
+settingspec-0.1.1.dist-info/WHEEL,sha256=bdMjkx77UosG9StsdhmkZ5NINL9k1Yz_ErcKcnkk7WA,90
+settingspec-0.1.1.dist-info/licenses/LICENSE-APACHE,sha256=lgCgk_esaIfAVyADtzSvlIRLil-MW3Ip7-deLap6CN0,11544
+settingspec-0.1.1.dist-info/licenses/LICENSE-MIT,sha256=wNMC8hJszGjWtSEhGDofRaa6_Hn34Epw9QmNaQJDSws,1089
+settingspec-0.1.1.dist-info/sboms/settingspec.cyclonedx.json,sha256=pHP9pWMtVVbN6eTt-7dIWHI_h-ihCPJQOjHlvsaR3ZQ,53175
+settingspec-0.1.1.dist-info/RECORD,,

settingspec-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.15.0)
+Root-Is-Purelib: false
+Tag: py3-none-win32

settingspec-0.1.1.dist-info/licenses/LICENSE-APACHE

@@ -0,0 +1,202 @@
+                                 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 2026 Arijit Basu
+
+   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.
+

settingspec-0.1.1.dist-info/licenses/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arijit Basu
+
+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.