bare-script 0.9.0__tar.gz

bare-script-0.9.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Craig A. Hobbs
+
+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.

bare-script-0.9.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.1
+Name: bare-script
+Version: 0.9.0
+Summary: bare-script
+Home-page: https://github.com/craigahobbs/bare-script
+Author: Craig A. Hobbs
+Author-email: craigahobbs@gmail.com
+License: MIT
+Keywords: bare-script
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Utilities
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: schema-markdown>=1.2.0
+
+bare-script
+===========
+
+.. |badge-status| image:: https://img.shields.io/pypi/status/bare-script
+   :alt: PyPI - Status
+   :target: https://pypi.python.org/pypi/bare-script/
+
+.. |badge-version| image:: https://img.shields.io/pypi/v/bare-script
+   :alt: PyPI
+   :target: https://pypi.python.org/pypi/bare-script/
+
+.. |badge-license| image:: https://img.shields.io/github/license/craigahobbs/bare-script-py
+   :alt: GitHub
+   :target: https://github.com/craigahobbs/bare-script-py/blob/main/LICENSE
+
+.. |badge-python| image:: https://img.shields.io/pypi/pyversions/bare-script
+   :alt: PyPI - Python Version
+   :target: https://www.python.org/downloads/
+
+|badge-status| |badge-version| |badge-license| |badge-python|
+
+BareScript is a light-weight scripting and expression language.
+
+
+Links
+-----
+
+- `The BareScript Language <https://craigahobbs.github.io/bare-script/language/>`__
+- `The BareScript Library <https://craigahobbs.github.io/bare-script-py/library/>`__
+- `The BareScript Expression Library <https://craigahobbs.github.io/bare-script-py/library/expression.html>`__
+- `API Documentation <https://craigahobbs.github.io/bare-script-py/>`__
+- `Source code <https://github.com/craigahobbs/bare-script-py>`__
+
+
+Executing BareScript
+--------------------
+
+To execute a BareScript script, parse the script using the
+`parse_script <https://craigahobbs.github.io/bare-script-py/scripts.html#parse-script>`__
+function. Then execute the script using the
+`execute_script <https://craigahobbs.github.io/bare-script-py/scripts.html#execute-script>`__
+function. For example:
+
+>>> from bare_script import execute_script, parse_script
+...
+>>> # Parse the script
+... script = parse_script('''\
+... # Double a number
+... function double(n):
+...     return n * 2
+... endfunction
+...
+... return N + ' times 2 is ' + double(N)
+... ''')
+...
+>>> # Execute the script
+... globals = {'N': 10}
+>>> print(execute_script(script, {'globals': globals}))
+10 times 2 is 20
+
+
+The BareScript Library
+^^^^^^^^^^^^^^^^^^^^^^
+
+`The BareScript Library <https://craigahobbs.github.io/bare-script-py/library/>`__
+includes a set of built-in functions for mathematical operations, object manipulation, array
+manipulation, regular expressions, HTTP fetch and more. The following example demonstrates the use
+of the
+`systemFetch <https://craigahobbs.github.io/bare-script-py/library/#var.vGroup='System'&systemfetch>`__,
+`objectGet <https://craigahobbs.github.io/bare-script-py/library/#var.vGroup='Object'&objectget>`__, and
+`arrayLength <https://craigahobbs.github.io/bare-script-py/library/#var.vGroup='Array'&arraylength>`__
+functions.
+
+>>> import urllib.request
+...
+>>> from bare_script import execute_script, fetch_http, parse_script
+...
+>>> # Parse the script
+... script = parse_script('''\
+... # Fetch the BareScript library documentation JSON
+... docs = jsonParse(systemFetch('https://craigahobbs.github.io/bare-script-py/library/library.json'))
+...
+... # Return the number of library functions
+... return 'The BareScript Library has ' + arrayLength(objectGet(docs, 'functions')) + ' functions'
+... ''')
+...
+>>> # Execute the script
+... print(execute_script(script, {'fetchFn': fetch_http}))
+The BareScript Library has 106 functions
+
+
+Evaluating BareScript Expressions
+---------------------------------
+
+To evaluate a
+`BareScript expression <https://craigahobbs.github.io/bare-script/language/#expressions>`__,
+parse the expression using the
+`parse_expression <https://craigahobbs.github.io/bare-script-py/expressions.html#parse-expression>`__
+function. Then evaluate the expression using the
+`evaluate_expression <https://craigahobbs.github.io/bare-script-py/expressions.html#evaluate-expression>`__
+function.
+
+Expression evaluation includes the
+`BareScript Expression Library <https://craigahobbs.github.io/bare-script-py/library/expression.html>`__,
+a set of built-in, spreadsheet-like functions.
+
+For example:
+
+>>> from bare_script import evaluate_expression, parse_expression
+...
+>>> # Parse the expression
+... expr = parse_expression('2 * max(a, b, c)')
+...
+>>> # Evaluate the expression
+... variables = {'a': 1, 'b': 2, 'c': 3}
+>>> print(evaluate_expression(expr, None, variables))
+6.0
+
+
+The BareScript Command-Line Interface (CLI)
+-------------------------------------------
+
+You can run BareScript from the command line using the BareScript CLI, "bare". BareScript script
+files use the ".bare" file extension.
+
+.. code-block:: sh
+
+    bare script.bare
+
+**Note:** In the BareScript CLI, import statements and the
+`systemFetch <https://craigahobbs.github.io/bare-script-py/library/#var.vGroup='System'&systemfetch>`__
+function read non-URL paths from the local file system.
+
+
+MarkdownUp, a Markdown Viewer with BareScript
+---------------------------------------------
+
+`MarkdownUp <https://craigahobbs.github.io/markdown-up/>`__
+is a Markdown Viewer that executes BareScript embedded within Markdown documents.
+`MarkdownUp <https://craigahobbs.github.io/markdown-up/>`__
+extends its
+`standard library <https://craigahobbs.github.io/markdown-up/library/>`__
+with functions for dynamically rendering Markdown text, drawing SVG images, etc.
+
+For example:
+
+.. code-block:: markdown
+
+    # Markdown Application
+
+    This is a Markdown document with embedded BareScript:
+
+    ~~~ markdown-script
+    markdownPrint('Hello, Markdown!')
+    ~~~
+
+
+Development
+-----------
+
+This package is developed using `python-build <https://github.com/craigahobbs/python-build#readme>`__.
+It was started using `python-template <https://github.com/craigahobbs/python-template#readme>`__ as follows:
+
+.. code-block:: sh
+
+    template-specialize python-template/template/ bare-script/ -k package bare-script -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs'

bare-script-0.9.0/README.rst

@@ -0,0 +1,166 @@
+bare-script
+===========
+
+.. |badge-status| image:: https://img.shields.io/pypi/status/bare-script
+   :alt: PyPI - Status
+   :target: https://pypi.python.org/pypi/bare-script/
+
+.. |badge-version| image:: https://img.shields.io/pypi/v/bare-script
+   :alt: PyPI
+   :target: https://pypi.python.org/pypi/bare-script/
+
+.. |badge-license| image:: https://img.shields.io/github/license/craigahobbs/bare-script-py
+   :alt: GitHub
+   :target: https://github.com/craigahobbs/bare-script-py/blob/main/LICENSE
+
+.. |badge-python| image:: https://img.shields.io/pypi/pyversions/bare-script
+   :alt: PyPI - Python Version
+   :target: https://www.python.org/downloads/
+
+|badge-status| |badge-version| |badge-license| |badge-python|
+
+BareScript is a light-weight scripting and expression language.
+
+
+Links
+-----
+
+- `The BareScript Language <https://craigahobbs.github.io/bare-script/language/>`__
+- `The BareScript Library <https://craigahobbs.github.io/bare-script-py/library/>`__
+- `The BareScript Expression Library <https://craigahobbs.github.io/bare-script-py/library/expression.html>`__
+- `API Documentation <https://craigahobbs.github.io/bare-script-py/>`__
+- `Source code <https://github.com/craigahobbs/bare-script-py>`__
+
+
+Executing BareScript
+--------------------
+
+To execute a BareScript script, parse the script using the
+`parse_script <https://craigahobbs.github.io/bare-script-py/scripts.html#parse-script>`__
+function. Then execute the script using the
+`execute_script <https://craigahobbs.github.io/bare-script-py/scripts.html#execute-script>`__
+function. For example:
+
+>>> from bare_script import execute_script, parse_script
+...
+>>> # Parse the script
+... script = parse_script('''\
+... # Double a number
+... function double(n):
+...     return n * 2
+... endfunction
+...
+... return N + ' times 2 is ' + double(N)
+... ''')
+...
+>>> # Execute the script
+... globals = {'N': 10}
+>>> print(execute_script(script, {'globals': globals}))
+10 times 2 is 20
+
+
+The BareScript Library
+^^^^^^^^^^^^^^^^^^^^^^
+
+`The BareScript Library <https://craigahobbs.github.io/bare-script-py/library/>`__
+includes a set of built-in functions for mathematical operations, object manipulation, array
+manipulation, regular expressions, HTTP fetch and more. The following example demonstrates the use
+of the
+`systemFetch <https://craigahobbs.github.io/bare-script-py/library/#var.vGroup='System'&systemfetch>`__,
+`objectGet <https://craigahobbs.github.io/bare-script-py/library/#var.vGroup='Object'&objectget>`__, and
+`arrayLength <https://craigahobbs.github.io/bare-script-py/library/#var.vGroup='Array'&arraylength>`__
+functions.
+
+>>> import urllib.request
+...
+>>> from bare_script import execute_script, fetch_http, parse_script
+...
+>>> # Parse the script
+... script = parse_script('''\
+... # Fetch the BareScript library documentation JSON
+... docs = jsonParse(systemFetch('https://craigahobbs.github.io/bare-script-py/library/library.json'))
+...
+... # Return the number of library functions
+... return 'The BareScript Library has ' + arrayLength(objectGet(docs, 'functions')) + ' functions'
+... ''')
+...
+>>> # Execute the script
+... print(execute_script(script, {'fetchFn': fetch_http}))
+The BareScript Library has 106 functions
+
+
+Evaluating BareScript Expressions
+---------------------------------
+
+To evaluate a
+`BareScript expression <https://craigahobbs.github.io/bare-script/language/#expressions>`__,
+parse the expression using the
+`parse_expression <https://craigahobbs.github.io/bare-script-py/expressions.html#parse-expression>`__
+function. Then evaluate the expression using the
+`evaluate_expression <https://craigahobbs.github.io/bare-script-py/expressions.html#evaluate-expression>`__
+function.
+
+Expression evaluation includes the
+`BareScript Expression Library <https://craigahobbs.github.io/bare-script-py/library/expression.html>`__,
+a set of built-in, spreadsheet-like functions.
+
+For example:
+
+>>> from bare_script import evaluate_expression, parse_expression
+...
+>>> # Parse the expression
+... expr = parse_expression('2 * max(a, b, c)')
+...
+>>> # Evaluate the expression
+... variables = {'a': 1, 'b': 2, 'c': 3}
+>>> print(evaluate_expression(expr, None, variables))
+6.0
+
+
+The BareScript Command-Line Interface (CLI)
+-------------------------------------------
+
+You can run BareScript from the command line using the BareScript CLI, "bare". BareScript script
+files use the ".bare" file extension.
+
+.. code-block:: sh
+
+    bare script.bare
+
+**Note:** In the BareScript CLI, import statements and the
+`systemFetch <https://craigahobbs.github.io/bare-script-py/library/#var.vGroup='System'&systemfetch>`__
+function read non-URL paths from the local file system.
+
+
+MarkdownUp, a Markdown Viewer with BareScript
+---------------------------------------------
+
+`MarkdownUp <https://craigahobbs.github.io/markdown-up/>`__
+is a Markdown Viewer that executes BareScript embedded within Markdown documents.
+`MarkdownUp <https://craigahobbs.github.io/markdown-up/>`__
+extends its
+`standard library <https://craigahobbs.github.io/markdown-up/library/>`__
+with functions for dynamically rendering Markdown text, drawing SVG images, etc.
+
+For example:
+
+.. code-block:: markdown
+
+    # Markdown Application
+
+    This is a Markdown document with embedded BareScript:
+
+    ~~~ markdown-script
+    markdownPrint('Hello, Markdown!')
+    ~~~
+
+
+Development
+-----------
+
+This package is developed using `python-build <https://github.com/craigahobbs/python-build#readme>`__.
+It was started using `python-template <https://github.com/craigahobbs/python-template#readme>`__ as follows:
+
+.. code-block:: sh
+
+    template-specialize python-template/template/ bare-script/ -k package bare-script -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs'

bare-script-0.9.0/pyproject.toml

@@ -0,0 +1,2 @@
+[build-system]
+requires = ["setuptools", "wheel"]

bare-script-0.9.0/setup.cfg

@@ -0,0 +1,39 @@
+[metadata]
+name = bare-script
+version = 0.9.0
+url = https://github.com/craigahobbs/bare-script
+author = Craig A. Hobbs
+author_email = craigahobbs@gmail.com
+license = MIT
+description = bare-script
+long_description = file:README.rst
+long_description_content_type = text/x-rst
+keywords = bare-script
+classifiers = 
+	Development Status :: 5 - Production/Stable
+	Intended Audience :: Developers
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+	Programming Language :: Python :: 3.8
+	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
+	Topic :: Utilities
+
+[options]
+packages = bare_script
+package_dir = 
+	= src
+install_requires = 
+	schema-markdown >= 1.2.0
+
+[options.entry_points]
+console_scripts = 
+	bare = bare_script.bare:main
+	baredoc = bare_script.baredoc:main
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

bare-script-0.9.0/src/bare_script/__init__.py

@@ -0,0 +1,33 @@
+# Licensed under the MIT License
+# https://github.com/craigahobbs/bare-script-py/blob/main/LICENSE
+
+"""
+bare-script package
+"""
+
+from .library import \
+    EXPRESSION_FUNCTIONS, \
+    SCRIPT_FUNCTIONS
+
+from .model import \
+    BARE_SCRIPT_TYPES, \
+    lint_script, \
+    validate_expression, \
+    validate_script
+
+from .options import \
+    fetch_http, \
+    fetch_read_only, \
+    fetch_read_write, \
+    log_print, \
+    url_file_relative
+
+from .parser import \
+    BareScriptParserError, \
+    parse_expression, \
+    parse_script
+
+from .runtime import \
+    BareScriptRuntimeError, \
+    evaluate_expression, \
+    execute_script

bare-script-0.9.0/src/bare_script/__main__.py

@@ -0,0 +1,12 @@
+# Licensed under the MIT License
+# https://github.com/craigahobbs/bare-script-py/blob/main/LICENSE
+
+"""
+bare-script top-level script environment
+"""
+
+from .bare import main
+
+
+if __name__ == '__main__': # pragma: no cover
+    main()

bare-script-0.9.0/src/bare_script/bare.py

@@ -0,0 +1,109 @@
+# Licensed under the MIT License
+# https://github.com/craigahobbs/bare-script-py/blob/main/LICENSE
+
+"""
+bare-script command-line interface (CLI) main module
+"""
+
+import argparse
+from functools import partial
+import sys
+import time
+
+from .model import lint_script
+from .options import fetch_read_write, log_print, url_file_relative
+from .parser import parse_script
+from .runtime import execute_script
+
+
+def main(argv=None):
+    """
+    BareScript command-line interface (CLI) main entry point
+    """
+
+    # Command line arguments
+    parser = argparse.ArgumentParser(prog='bare', description='The BareScript command-line interface')
+    parser.add_argument('filename', nargs='*', action=_ScriptAction, help='files to process')
+    parser.add_argument('-c', '--code', nargs=1, action=_ScriptAction, help='execute the BareScript code')
+    parser.add_argument('-d', '--debug', action='store_true', help='enable debug mode')
+    parser.add_argument('-s', '--static', action='store_true', help='perform static analysis')
+    parser.add_argument('-v', '--var', nargs=2, action='append', metavar=('VAR', 'EXPR'),
+                        help='set a global variable to an expression value')
+    args = parser.parse_args(args=argv)
+
+    status_code = 0
+    current_file = None
+    try:
+        # Parse and execute all source files in order
+        globals_ = dict(args.var) if args.var is not None else {}
+        for file_, source in args.files:
+            current_file = file_
+
+            # Parse the source
+            script = parse_script(source if source is not None else fetch_read_write({'url': file_}))
+
+            # Run the bare-script linter?
+            if args.static or args.debug:
+                warnings = lint_script(script)
+                warning_prefix = f'BareScript: Static analysis "{file_}" ...'
+                if not warnings:
+                    print(f'{warning_prefix} OK')
+                else:
+                    print(f'{warning_prefix} {len(warnings)} warning{"s" if len(warnings) > 1 else ""}:')
+                    for warning in warnings:
+                        print(f'BareScript:     {warning}')
+                    if args.static:
+                        # pylint: disable=broad-exception-raised
+                        raise Exception('Static analysis failed')
+            if args.static:
+                continue
+
+            # Execute the script
+            time_begin = time.time()
+            result = execute_script(script, {
+                'debug': args.debug or False,
+                'fetchFn': fetch_read_write,
+                'globals': globals_,
+                'logFn': log_print,
+                'systemPrefix': 'https://craigahobbs.github.io/markdown-up/include/',
+                'urlFn': partial(url_file_relative, file_)
+            })
+            if isinstance(result, (int, float)) and int(result) == result and 0 <= result <= 255:
+                status_code = int(result)
+            else:
+                status_code = 1 if result else 0
+
+            # Log script execution end with timing
+            if args.debug:
+                time_end = time.time()
+                print(f'BareScript: Script executed in {1000 * (time_end - time_begin):.1f} milliseconds')
+
+            # Stop on error status code
+            if status_code != 0:
+                break
+
+    except Exception as e: # pylint: disable=broad-exception-caught
+        if current_file is not None:
+            print(f'{current_file}:')
+        print(str(e))
+        status_code = 1
+
+    # Return the status code
+    sys.exit(status_code)
+
+
+# Custom argparse action for script file arguments
+class _ScriptAction(argparse.Action):
+
+    def __call__(self, parser, namespace, values, option_string=None):
+        files = getattr(namespace, 'files', [])
+        if option_string in ['-c', '--code']:
+            code_count = getattr(namespace, 'code_count', 0)
+            code_count += 1
+            setattr(namespace, 'code_count', code_count)
+            for value in values:
+                files.append((f'-c {code_count}', value))
+        elif option_string is None:
+            for value in values:
+                files.append((value, None))
+        setattr(namespace, 'files', files)