settingspec 0.1.0__tar.gz → 0.1.2__tar.gz

{settingspec-0.1.0 → settingspec-0.1.2}/Cargo.lock

@@ -564,7 +564,7 @@ dependencies = [
 
 [[package]]
 name = "settingspec"
-version = "0.1.0"
+version = "0.1.2"
 dependencies = [
  "anyhow",
  "assert_cmd",

{settingspec-0.1.0 → settingspec-0.1.2}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "settingspec"
-version = "0.1.0"
+version = "0.1.2"
 edition = "2024"
 description = "One file for all environments, all languages, all submodules."
 readme = "README.md"

settingspec-0.1.2/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: settingspec
+Version: 0.1.2
+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.0 → settingspec-0.1.2}/README.md

@@ -10,7 +10,15 @@
 [![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)
-[![Docker Image Version](https://img.shields.io/docker/v/sayanarijit/settingspec?label=docker)](https://hub.docker.com/r/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
 

{settingspec-0.1.0 → settingspec-0.1.2}/pyproject.toml

@@ -10,4 +10,14 @@ classifiers = [
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
-dynamic = ["version"]
+dynamic = [
+  "version",
+  "description",
+  "readme",
+  "license",
+  "authors",
+  "keywords",
+  "urls",
+]
+[tool.maturin]
+bindings = "bin"

{settingspec-0.1.0 → settingspec-0.1.2}/src/cli.rs

@@ -224,7 +224,7 @@ fn execute_run(ctx: &ExecutionContext, command_args: &[String]) -> Result<()> {
     Ok(())
 }
 
-pub fn write_export_file(path: &Path, content: &str, mode: u32) -> Result<()> {
+pub fn write_export_file(path: &Path, content: &str, _mode: u32) -> Result<()> {
     if let Some(parent) = path.parent()
         && !parent.as_os_str().is_empty()
     {
@@ -236,7 +236,7 @@ pub fn write_export_file(path: &Path, content: &str, mode: u32) -> Result<()> {
     #[cfg(unix)]
     {
         use std::os::unix::fs::PermissionsExt;
-        let perms = std::fs::Permissions::from_mode(mode);
+        let perms = std::fs::Permissions::from_mode(_mode);
         let _ = std::fs::set_permissions(path, perms);
     }
 
@@ -296,12 +296,12 @@ fn is_entry_in_gitignore(existing_content: &str, entry: &str) -> bool {
         }
         // In git, a pattern without '/' matches anywhere in the repository:
         // E.g. if .gitignore has "settings.toml", it matches "subdir/settings.toml".
-        if !trimmed.starts_with('/') && !norm_line.contains('/') {
-            if let Some((_, file_name)) = norm_entry.rsplit_once('/') {
-                if file_name == norm_line {
-                    return true;
-                }
-            }
+        if !trimmed.starts_with('/')
+            && !norm_line.contains('/')
+            && let Some((_, file_name)) = norm_entry.rsplit_once('/')
+            && file_name == norm_line
+        {
+            return true;
         }
     }
     false

{settingspec-0.1.0 → settingspec-0.1.2}/src/model.rs

@@ -155,14 +155,16 @@ where
     D: Deserializer<'de>,
 {
     let val = i64::deserialize(deserializer)?;
-    let mode_u32 = if val == 0x600 || val == 0o600 {
-        0o600
-    } else if (0..=0o777).contains(&val) {
-        val as u32
-    } else {
-        0o600
-    };
-    Ok(mode_u32)
+    if (0..=0o777).contains(&val) {
+        return Ok(val as u32);
+    }
+    let hex = format!("{:x}", val);
+    if let Ok(octal) = u32::from_str_radix(&hex, 8)
+        && (0..=0o7777).contains(&octal)
+    {
+        return Ok(octal);
+    }
+    Ok(0o600)
 }
 
 /// A field that accepts either a boolean toggle or a string value in TOML.

settingspec-0.1.0/PKG-INFO

@@ -1,9 +0,0 @@
-Metadata-Version: 2.4
-Name: settingspec
-Version: 0.1.0
-Classifier: Programming Language :: Rust
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-License-File: LICENSE-APACHE
-License-File: LICENSE-MIT
-Requires-Python: >=3.8