yamlscript 0.2.3__tar.gz → 0.2.4__tar.gz

{yamlscript-0.2.3/lib/yamlscript.egg-info → yamlscript-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yamlscript
-Version: 0.2.3
+Version: 0.2.4
 Summary: Program in YAML — Code is Data
 Home-page: https://github.com/ingydotnet/yamlscript
 Author: Ingy döt Net

yamlscript-0.2.4/ReadMe.md

@@ -0,0 +1,178 @@
+<!-- DO NOT EDIT — THIS FILE WAS GENERATED -->
+
+YAMLScript
+==========
+
+Add Logic to Your YAML Files
+
+
+## Quick Start
+
+This library lets you load YAML files that may or may not contain
+[YAMLScript](https://yamlscript.org) functional programming logic.
+You can use it as a drop-in replacement for your current YAML loader.
+
+Here's an example `config.yaml` that makes use of YAMLScript functions.
+
+```yaml
+# config.yaml with YAMLScript:
+!YS-v0:
+
+# Define variables
+db-host =: ENV.DB_HOST || 'localhost'
+db-port =: ENV.DB_PORT || 5432
+deploy =: ENV.DEPLOYMENT || 'dev'
+:when deploy !~ /^(dev|stage|prod)/:
+  die: |
+    Invalid deployment value '$deploy'.
+    Must be one of: dev | stage | prod
+
+# Normal YAML data
+description: Dynamic application configuration
+
+# Dynamic data values
+database:
+  host:: db-host
+  port:: db-port:num
+  name:: "app_$deploy"
+
+# Import external data
+features:: load('common.yaml').features
+
+# Use logic and conditions
+cache:
+  # Variable scoped to this mapping
+  enabled =: deploy == 'production'
+
+  directory: .cache
+  enabled:: enabled
+  limit: 100
+  # Conditional key/value pairs
+  :when enabled::
+    limit:: 1000
+    ttl:: 60 * 60  # 3600
+```
+
+
+## What is YAMLScript?
+
+YAMLScript is a functional programming language that can be embedded in YAML.
+Its syntax is 100% YAML so files that embed it are still valid YAML files.
+
+The YAMLScript project provides YAML loader libraries for many programming
+languages.
+They can be used to load any YAML config files properly, whether or not they
+contain functional programming logic.
+
+It's perfect for:
+
+* **Configuration files** that need logic, variables, and dynamic values
+* **Data transformation** with built-in functions for JSON, YAML, and text
+  processing
+* **Templating** with powerful string interpolation and data manipulation
+* **Scripting** as a complete functional programming language
+
+
+## Key Features
+
+* **Drop-in YAML replacement** – Works with your existing YAML files
+* **Variables & functions** – Define and reuse values throughout your files
+* **External data loading** – Import JSON, YAML, or data from URLs
+* **Conditional logic** – Use if/then/else and pattern matching
+* **Data transformation** – Built-ins for transforming & manipulating data
+* **String interpolation** – Embed expressions/variables directly in strings
+* **No JVM required** – Runs as a native library despite compiling to Clojure
+
+
+## How It Works
+
+YAMLScript extends YAML with a simple, elegant syntax:
+
+```yaml
+# file.yaml
+!YS-v0:               # Enable YAMLScript
+
+name =: 'World'       # Variable assignment
+nums =:: [1, 2, 3]    # Any YAML value
+
+# Literal YAML with ':'
+a key: a value
+
+# Evaluated expressions with '::'
+message:: "Hello, $name!"
+sum:: nums.reduce(+)
+timestamp:: now():str
+```
+
+You can load this file from a program as described below, or you can use the
+`ys` YAMLScript binary to load the file from the command line:
+
+```bash
+$ ys -Y file.yaml
+a key: a value
+message: Hello, World!
+sum: 6
+timestamp: '2025-09-14T22:35:42.832470203Z'
+```
+
+Under the hood, YAMLScript compiles YAML to Clojure and evaluates it, giving
+you access to a rich functional programming environment.
+
+## Python Usage
+
+Use `yamlscript.py` as a drop-in replacement for your current YAML loader:
+
+```python
+# program.py
+from yamlscript import YAMLScript
+import json
+
+ys = YAMLScript()
+
+# Load from file
+input = open('config.yaml').read()
+config = ys.load(input)
+
+# Convert to JSON
+print(json.dumps(config, indent=2))
+```
+
+
+## Installation
+
+Install YAMLScript for Python and the `libys.so` shared library:
+
+```bash
+pip install yamlscript
+curl -sSL https://yamlscript.org/install | bash
+```
+
+See <https://yamlscript.org/doc/install/> for more info.
+
+
+### Requirements
+
+* Python 3.8 or higher
+
+## See Also
+
+* [YAMLScript Web Site](https://yamlscript.org)
+* [Learn YAMLScript](https://exercism.org/tracks/yamlscript)
+* [YAMLScript Blog](https://yamlscript.org/blog)
+* [YAMLScript Source Code](https://github.com/yaml/yamlscript)
+* [YAMLScript Programs](https://rosettacode.org/wiki/Category:YAMLScript)
+* [YAML](https://yaml.org)
+* [Clojure](https://clojure.org)
+
+
+## Authors
+
+* [Ingy döt Net](https://github.com/ingydotnet)
+
+## License & Copyright
+
+Copyright 2022-2025 Ingy döt Net <ingy@ingy.net>
+
+This project is licensed under the terms of the `MIT` license.
+See [LICENSE](https://github.com/yaml/yamlscript/blob/main/License) for more
+details.

{yamlscript-0.2.3 → yamlscript-0.2.4}/lib/yamlscript/__init__.py

@@ -16,7 +16,7 @@ object that the YAMLScript code evaluates to.
 # This value is automatically updated by 'make bump'.
 # The version number is used to find the correct shared library file.
 # We currently only support binding to an exact version of libys.
-yamlscript_version = '0.2.3'
+yamlscript_version = '0.2.4'
 
 import os, sys
 import ctypes
@@ -40,7 +40,7 @@ def find_libys_path():
       "Unsupported platform '%s' for yamlscript." % sys.platform)
 
   # We currently bind to an exact version of libys.
-  # eg 'libys.so.0.2.3'
+  # eg 'libys.so.0.2.4'
   libys_name = \
     "libys.%s.%s" % (so, yamlscript_version)
 

{yamlscript-0.2.3 → yamlscript-0.2.4/lib/yamlscript.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yamlscript
-Version: 0.2.3
+Version: 0.2.4
 Summary: Program in YAML — Code is Data
 Home-page: https://github.com/ingydotnet/yamlscript
 Author: Ingy döt Net

{yamlscript-0.2.3 → yamlscript-0.2.4}/setup.py

@@ -1,4 +1,4 @@
-version = '0.2.3'
+version = '0.2.4'
 
 from setuptools import setup
 import pathlib

yamlscript-0.2.3/ReadMe.md

@@ -1,166 +0,0 @@
-<!-- DO NOT EDIT — THIS FILE WAS GENERATED -->
-
-YS / YAMLScript
-===============
-
-Add Logic to Your YAML Files
-
-
-## Synopsis
-
-Load `file.yaml` with YS:
-
-```yaml
-!YS-v0:
-
-# Get data from external sources:
-names-url =:
-  'github:dominictarr/random-name/first-names.json'
-
-name-list =: names-url:curl:json/load
-
-# Data object with literal keys and generated values:
-name:: name-list:shuffle:first
-aka:: name-list:rand-nth
-age:: &num 2 * 3 * 7
-color:: &hue
-  rand-nth: qw(red green blue yellow)
-title:: "$(*num) shades of $(*hue)."
-```
-
-and get:
-```json
-{
-  "name": "Dolores",
-  "aka": "Anita",
-  "age": 42,
-  "color": "green",
-  "title": "42 shades of green."
-}
-```
-
-
-## Description
-
-[YS](https://yamlscript.org) is a functional programming language with a clean
-YAML syntax.
-
-YS can be used for enhancing ordinary [YAML](https://yaml.org) files with
-functional operations, such as:
-
-* Import (parts of) other YAML files to any node
-* String interpolation including function calls
-* Data transforms including ones defined by you
-
-This YS library should be a drop-in replacement for your current YAML loader!
-
-Most existing YAML files are already valid YS files.
-This means that YS works as a normal YAML loader, but can also evaluate
-functional expressions if asked to.
-
-Under the hood, YS code compiles to the Clojure programming language.
-This makes YS a complete functional programming language right out of the box.
-
-Even though YS compiles to Clojure, and Clojure compiles to Java, there is no
-dependency on Java or the JVM.
-YS is compiled to a native shared library (`libys.so`) that can be used
-by any programming language that can load shared libraries.
-
-To see the Clojure code that YS compiles to, you can use the YS
-CLI binary `ys` to run:
-
-```text
-$ ys --compile file.ys
-(let
- [names-url "https://raw.githubusercontent.com/dominictarr/random-name/master/first-names.json"
-  name-list (json/load (curl names-url))]
- (%
-  "name" (first (shuffle name-list))
-  "aka" (rand-nth name-list)
-  "age" (_& 'num (mul+ 2 3 7))
-  "color" (_& 'hue (rand-nth (qw red green blue yellow)))
-  "title" (str (_** 'num) " shades of " (_** 'hue) ".")))
-```
-
-## Python Usage
-
-File `prog.py`:
-
-```python
-from yamlscript import YAMLScript
-ys = YAMLScript()
-input = open('file.ys').read()
-data = ys.load(input)
-print(data)
-```
-
-File `file.ys`:
-
-```yaml
-!YS-v0:
-
-name =: "World"
-
-foo: [1, 2, ! inc(41)]
-bar:: load("other.yaml")
-baz:: "Hello, $name!"
-```
-
-File `other.yaml`:
-
-```yaml
-oh: Hello
-```
-
-Run:
-
-```text
-$ python prog.py
-{'foo': [1, 2, 42], 'bar': {'oh': 'Hello'}, 'baz': 'Hello, World!'}
-```
-
-
-## Installation
-
-You can install this module like any other Python module:
-
-```bash
-pip install yamlscript
-```
-
-but you will need to have a system install of `libys.so`.
-
-One simple way to do that is with:
-
-```bash
-curl https://yamlscript.org/install | bash
-```
-
-> Note: The above command will install the latest version of the YAMLScript
-command line utility, `ys`, and the shared library, `libys.so`, into
-`~/local/bin` and `~/.local/lib` respectively.
-
-See <https://yamlscript.org/doc/install/> for more info.
-
-## See Also
-
-* [YS Web Site](https://yamlscript.org)
-* [YS Blog](https://yamlscript.org/blog)
-* [YS Source Code](https://github.com/yaml/yamlscript)
-* [YS Samples](https://github.com/yaml/yamlscript/tree/main/sample)
-* [YS Programs](https://rosettacode.org/wiki/Category:YAMLScript)
-* [YAML](https://yaml.org)
-* [Clojure](https://clojure.org)
-
-
-## Authors
-
-* [Ingy döt Net](https://github.com/ingydotnet)
-
-## License & Copyright
-
-Copyright 2022-2025 Ingy döt Net <ingy@ingy.net>
-
-This project is licensed under the terms of the `MIT` license.
-See [LICENSE](https://github.com/yaml/yamlscript/blob/main/License) for
-more details.