bare-script 0.9.0__py3-none-any.whl

bare_script-0.9.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,16 @@
+bare_script/__init__.py,sha256=1KadiOevH2lGAy5tIqsnxtLIR96YtnINlSD186_JgU8,635
+bare_script/__main__.py,sha256=vgFzmiNuP05IKyuY6FrDLChkleyvER9L22OJNxsyf74,232
+bare_script/bare.py,sha256=u4wpWymdskvrkS8lw8xdTb6D2aREullJMycEQPwxOoQ,4217
+bare_script/baredoc.py,sha256=FHfYOpSl2U39vRtGVaM6E-LV6V7VSWTld07c2OqBGmA,5120
+bare_script/library.py,sha256=nMNv8mAsMQmbmD_M0JdrW28YJAncG87MzqUJqnBKv2Q,57314
+bare_script/model.py,sha256=5cz0OJ99fDFM1QYOU3DrvVNSN85xFY2HoLry_wHoit4,4599
+bare_script/options.py,sha256=ov6sifB36hACdrrTEOWCuRJpS3zqJejaE35TOSHRR80,2644
+bare_script/parser.py,sha256=Psj9ApCGjeSoSRSkyq0QX-J-FncyT6tborXjuR1HPVo,29024
+bare_script/runtime.py,sha256=8b1TGm9yNxyyfc6nXIOUy1qYPdMcDF-a59Ri__4Z9YU,14369
+bare_script/value.py,sha256=QkRM-rVZ-u-n31XgrirCWCWCezbQfRFVSuqQUpMssYI,5547
+bare_script-0.9.0.dist-info/LICENSE,sha256=legUTdYSyuztIaeQs3C2qoknw9dwIEdEVfOiF1UTaTs,1081
+bare_script-0.9.0.dist-info/METADATA,sha256=oxYEsHpHeBJSPha2t6n7-HvrT-U3mc8djNetgMvmTR8,6549
+bare_script-0.9.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+bare_script-0.9.0.dist-info/entry_points.txt,sha256=FkrlFNSpZQc5RZR2HtyWJnBCGY0QuqVwlj1xMfDf0P0,82
+bare_script-0.9.0.dist-info/top_level.txt,sha256=LJr6EHeCFlEIlvy5P794yqrYxa3Ptu2zY1ziNxv2QRQ,12
+bare_script-0.9.0.dist-info/RECORD,,

bare_script-0.9.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.42.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

bare_script-0.9.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+bare = bare_script.bare:main
+baredoc = bare_script.baredoc:main

bare_script-0.9.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+bare_script