markdown-up 3.2.0__tar.gz → 3.3.0__tar.gz

markdown_up-3.3.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: markdown-up
+Version: 3.3.0
+Summary: MarkdownUp is a Markdown viewer
+Author-email: "Craig A. Hobbs" <craigahobbs@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/craigahobbs/markdown-up-py
+Keywords: Markdown,viewer
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Utilities
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: chisel<2.5.0,>=2.4.0
+Requires-Dist: waitress>=3.0.0
+Dynamic: license-file
+
+# markdown-up
+
+[![PyPI - Status](https://img.shields.io/pypi/status/markdown-up)](https://pypi.org/project/markdown-up/)
+[![PyPI](https://img.shields.io/pypi/v/markdown-up)](https://pypi.org/project/markdown-up/)
+[![GitHub](https://img.shields.io/github/license/craigahobbs/markdown-up-py)](https://github.com/craigahobbs/markdown-up-py/blob/main/LICENSE)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/markdown-up)](https://pypi.org/project/markdown-up/)
+
+MarkdownUp is a Markdown viewer.
+
+
+## Install MarkdownUp
+
+Use Python's `pip` to install MarkdownUp as follows:
+
+~~~
+pip install markdown-up
+~~~
+
+
+## View Markdown Files
+
+To start MarkdownUp, open a terminal and run the `markdown-up` application:
+
+~~~
+markdown-up
+~~~
+
+The `markdown-up` application opens the web browser to the MarkdownUp file browser, which allows you
+to view Markdown or HTML files and navigate directories. To view a file, click on its link.
+
+You can view a specific file as follows:
+
+~~~
+markdown-up README.md
+~~~
+
+**Note:** MarkdownUp runs entirely offline. It does not use an external service to render Markdown
+files.
+
+
+## Running MarkdownUp
+
+When you run the `markdown-up` application, in addition to opening the web browser, it starts a
+[chisel](https://pypi.org/project/chisel/)
+backend API application using
+[waitress](https://pypi.org/project/waitress/).
+
+
+### Automatic HTML for Markdown Files
+
+When you run MarkdownUp and click on a Markdown file link, the link navigates to an HTML file that
+renders the Markdown file. Every Markdown file hosted by MarkdownUp has a corresponding `.html` file
+of the same name. For example, if you run MarkdownUp in a directory that has the following Markdown
+files: "README.md" and "CHANGELOG.md". The MarkdownUp service automatically generates "README.html"
+and "CHANGELOG.html" files.
+
+The generated `.html` files are HTML stubs for the
+[MarkdownUp frontend application](https://github.com/craigahobbs/markdown-up#readme).
+All Markdown parsing and rendering are done on the client.
+
+
+### Configuration File
+
+The
+[MarkdownUp Application Configuration File](https://craigahobbs.github.io/markdown-up-py/config.html#var.vName='MarkdownUpConfig'),
+`markdown-up.json`, allows you to enable release mode, set the number of backend server threads, and more.
+
+
+### Command-Line Arguments
+
+The `markdown-up` application has the following command-line arguments:
+
+```
+usage: markdown-up [-h] [-p N] [-t N] [-n] [-r] [-q] [-c FILE] [path]
+
+positional arguments:
+  path                the file or directory to view (default is ".")
+
+options:
+  -h, --help          show this help message and exit
+  -p, --port N        the application port (default is 8080)
+  -t, --threads N     the number of web server threads (default is 8)
+  -n, --no-browser    don't open a web browser
+  -r, --release       release mode (cache statics, remove documentation and index)
+  -q, --quiet         hide access logging
+  -c, --config FILE   the application config filename (default is "markdown-up.json")
+  ```
+
+
+## MarkdownUp Applications
+
+With MarkdownUp, you can write client-rendered frontend applications using
+[BareScript](https://craigahobbs.github.io/bare-script/language/).
+MarkdownUp applications are created by adding `markdown-script` fenced code blocks containing
+[BareScript](https://craigahobbs.github.io/bare-script/language/)
+to a Markdown file and viewing it with the MarkdownUp frontend application. When the Markdown file
+is rendered, the BareScript is executed and its results are rendered in place. For example:
+
+~~~markdown
+# Frontend Hello World
+
+```markdown-script
+markdownPrint('Hello, **World**!!')
+```
+~~~
+
+
+### MarkdownUp Application Reference
+
+[The BareScript Language](https://craigahobbs.github.io/bare-script/language/)
+
+[The BareScript Library](https://craigahobbs.github.io/bare-script/library/)
+
+[MarkdownUp Frontend Examples](https://craigahobbs.github.io/#var.vPage='MarkdownUp')
+
+
+### MarkdownUp Backend Applications
+
+MarkdownUp no longer hosts BareScript backend APIs. To write a backend application in BareScript, use the
+[bare-script](https://pypi.org/project/bare-script/) package's
+[WSGI support](https://craigahobbs.github.io/bare-script-py/wsgi.html).
+
+
+## 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:
+
+~~~
+template-specialize python-template/template/ markdown-up-py/ -k package markdown-up -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapi 1
+~~~

markdown_up-3.3.0/README.md

@@ -0,0 +1,131 @@
+# markdown-up
+
+[![PyPI - Status](https://img.shields.io/pypi/status/markdown-up)](https://pypi.org/project/markdown-up/)
+[![PyPI](https://img.shields.io/pypi/v/markdown-up)](https://pypi.org/project/markdown-up/)
+[![GitHub](https://img.shields.io/github/license/craigahobbs/markdown-up-py)](https://github.com/craigahobbs/markdown-up-py/blob/main/LICENSE)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/markdown-up)](https://pypi.org/project/markdown-up/)
+
+MarkdownUp is a Markdown viewer.
+
+
+## Install MarkdownUp
+
+Use Python's `pip` to install MarkdownUp as follows:
+
+~~~
+pip install markdown-up
+~~~
+
+
+## View Markdown Files
+
+To start MarkdownUp, open a terminal and run the `markdown-up` application:
+
+~~~
+markdown-up
+~~~
+
+The `markdown-up` application opens the web browser to the MarkdownUp file browser, which allows you
+to view Markdown or HTML files and navigate directories. To view a file, click on its link.
+
+You can view a specific file as follows:
+
+~~~
+markdown-up README.md
+~~~
+
+**Note:** MarkdownUp runs entirely offline. It does not use an external service to render Markdown
+files.
+
+
+## Running MarkdownUp
+
+When you run the `markdown-up` application, in addition to opening the web browser, it starts a
+[chisel](https://pypi.org/project/chisel/)
+backend API application using
+[waitress](https://pypi.org/project/waitress/).
+
+
+### Automatic HTML for Markdown Files
+
+When you run MarkdownUp and click on a Markdown file link, the link navigates to an HTML file that
+renders the Markdown file. Every Markdown file hosted by MarkdownUp has a corresponding `.html` file
+of the same name. For example, if you run MarkdownUp in a directory that has the following Markdown
+files: "README.md" and "CHANGELOG.md". The MarkdownUp service automatically generates "README.html"
+and "CHANGELOG.html" files.
+
+The generated `.html` files are HTML stubs for the
+[MarkdownUp frontend application](https://github.com/craigahobbs/markdown-up#readme).
+All Markdown parsing and rendering are done on the client.
+
+
+### Configuration File
+
+The
+[MarkdownUp Application Configuration File](https://craigahobbs.github.io/markdown-up-py/config.html#var.vName='MarkdownUpConfig'),
+`markdown-up.json`, allows you to enable release mode, set the number of backend server threads, and more.
+
+
+### Command-Line Arguments
+
+The `markdown-up` application has the following command-line arguments:
+
+```
+usage: markdown-up [-h] [-p N] [-t N] [-n] [-r] [-q] [-c FILE] [path]
+
+positional arguments:
+  path                the file or directory to view (default is ".")
+
+options:
+  -h, --help          show this help message and exit
+  -p, --port N        the application port (default is 8080)
+  -t, --threads N     the number of web server threads (default is 8)
+  -n, --no-browser    don't open a web browser
+  -r, --release       release mode (cache statics, remove documentation and index)
+  -q, --quiet         hide access logging
+  -c, --config FILE   the application config filename (default is "markdown-up.json")
+  ```
+
+
+## MarkdownUp Applications
+
+With MarkdownUp, you can write client-rendered frontend applications using
+[BareScript](https://craigahobbs.github.io/bare-script/language/).
+MarkdownUp applications are created by adding `markdown-script` fenced code blocks containing
+[BareScript](https://craigahobbs.github.io/bare-script/language/)
+to a Markdown file and viewing it with the MarkdownUp frontend application. When the Markdown file
+is rendered, the BareScript is executed and its results are rendered in place. For example:
+
+~~~markdown
+# Frontend Hello World
+
+```markdown-script
+markdownPrint('Hello, **World**!!')
+```
+~~~
+
+
+### MarkdownUp Application Reference
+
+[The BareScript Language](https://craigahobbs.github.io/bare-script/language/)
+
+[The BareScript Library](https://craigahobbs.github.io/bare-script/library/)
+
+[MarkdownUp Frontend Examples](https://craigahobbs.github.io/#var.vPage='MarkdownUp')
+
+
+### MarkdownUp Backend Applications
+
+MarkdownUp no longer hosts BareScript backend APIs. To write a backend application in BareScript, use the
+[bare-script](https://pypi.org/project/bare-script/) package's
+[WSGI support](https://craigahobbs.github.io/bare-script-py/wsgi.html).
+
+
+## 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:
+
+~~~
+template-specialize python-template/template/ markdown-up-py/ -k package markdown-up -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapi 1
+~~~

{markdown_up-3.2.0 → markdown_up-3.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "markdown-up"
-version = "3.2.0"
+version = "3.3.0"
 description = "MarkdownUp is a Markdown viewer"
 readme = "README.md"
 license = "MIT"
@@ -26,7 +26,6 @@ classifiers = [
     "Topic :: Utilities"
 ]
 dependencies = [
-    "bare-script >= 5.1.0, < 5.2.0",
     "chisel >= 2.4.0, < 2.5.0",
     "waitress >= 3.0.0"
 ]

{markdown_up-3.2.0 → markdown_up-3.3.0}/src/markdown_up/app.py

@@ -13,8 +13,6 @@ import urllib.parse
 
 import chisel
 
-from .api import load_api_requests
-
 
 class MarkdownUpApplication(chisel.Application):
     """
@@ -24,7 +22,7 @@ class MarkdownUpApplication(chisel.Application):
     __slots__ = ('root', 'release', 'add_request_lock')
 
 
-    def __init__(self, root, config=None, api_config=None):
+    def __init__(self, root, config=None):
         super().__init__()
         self.root = root
         self.release = config.get('release', False) if config else False
@@ -53,10 +51,6 @@ class MarkdownUpApplication(chisel.Application):
             self.add_static('index.html', content_type='text/html; charset=utf-8', urls=(('GET', '/'),))
             self.add_static('markdownUpIndex.bare')
 
-        # Add the backend APIs
-        if api_config:
-            self.add_requests(load_api_requests(root, config, api_config))
-
 
     def add_static(self, filename, content_type=None, urls=(('GET', None),), doc_group='MarkdownUp File Browser'):
         with importlib.resources.files('markdown_up.static').joinpath(filename).open('rb') as fh:

{markdown_up-3.2.0 → markdown_up-3.3.0}/src/markdown_up/main.py

@@ -13,7 +13,7 @@ import sys
 import threading
 import webbrowser
 
-from bare_script.include import schema_parse, schema_validate
+from schema_markdown import parse_schema_markdown, validate_type
 import waitress
 
 from .app import HTML_EXTS, MARKDOWN_EXTS, MarkdownUpApplication
@@ -41,14 +41,8 @@ def main(argv=None):
                         help="release mode (cache statics, remove documentation and index)")
     parser.add_argument('-q', '--quiet', action='store_true',
                         help="hide access logging")
-    parser.add_argument('-d', '--debug', action='store_true', default=None,
-                        help='backend debug mode')
-    parser.add_argument('-v', '--var', nargs=2, action='append', metavar=('VAR', 'EXPR'), default = [],
-                        help='set a backend global variable')
     parser.add_argument('-c', '--config', metavar='FILE', default='markdown-up.json',
                         help='the application config filename (default is "markdown-up.json")')
-    parser.add_argument('-a', '--api', metavar='FILE', default='markdown-up-api.json',
-                        help='the API config filename (default is "markdown-up-api.json")')
     args = parser.parse_args(args=argv)
 
     # Verify the path exists
@@ -71,27 +65,13 @@ def main(argv=None):
     config_path = os.path.normpath(os.path.join(root, args.config))
     if os.path.isfile(config_path):
         with open(config_path, 'r', encoding='utf-8') as config_file:
-            config = schema_validate(CONFIG_TYPES, 'MarkdownUpConfig', json.load(config_file))
+            config = validate_type(CONFIG_TYPES, 'MarkdownUpConfig', json.load(config_file))
     else:
         config = {}
 
-    # Load and validate the API configuration file
-    api_path = os.path.normpath(os.path.join(root, args.api))
-    if os.path.isfile(api_path):
-        with open(api_path, 'r', encoding='utf-8') as api_file:
-            api_config = schema_validate(CONFIG_TYPES, 'MarkdownUpAPIConfig', json.load(api_file))
-    else:
-        api_config = None
-
-    # Add argumentsg to the config
-    config['debug'] = args.debug if args.debug is not None else config.get('debug', False)
+    # Add arguments to the config
     config['release'] = args.release if args.release is not None else config.get('release', False)
     config['threads'] = max(1, args.threads if args.threads is not None else config.get('threads', 8))
-    if args.var:
-        if 'globals' not in config:
-            config['globals'] = {}
-        for key, value in args.var:
-            config['globals'][key] = value
 
     # Construct the URL
     host = '127.0.0.1'
@@ -112,7 +92,7 @@ def main(argv=None):
         webbrowser_thread.start()
 
     # Create the WSGI application
-    wsgiapp = MarkdownUpApplication(root, config, api_config)
+    wsgiapp = MarkdownUpApplication(root, config)
     wsgiapp_wrap = wsgiapp if args.quiet else partial(_wsgiapp_log_access, wsgiapp)
 
     # Host the application
@@ -131,7 +111,7 @@ def _wsgiapp_log_access(wsgiapp, environ, start_response):
 
 
 # The backend configuration schema
-CONFIG_TYPES = schema_parse('''\
+CONFIG_TYPES = parse_schema_markdown('''\
 group "Application Configuration"
 
 
@@ -141,45 +121,6 @@ struct MarkdownUpConfig
     # If true, run in release mode. Default is false.
     optional bool release
 
-    # If true, run in debug mode. Default is false.
-    optional bool debug
-
     # The number of backend server threads. Default is 8.
     optional int threads
-
-    # Global variables
-    optional string{} globals
-
-
-group "API Configuration"
-
-
-# The MarkdownUp API configuration (e.g. `markdown-up-api.json`)
-struct MarkdownUpAPIConfig
-
-    # The API schema markdown POSIX file paths
-    string[] schemas
-
-    # The API BareScript POSIX file paths
-    string[] scripts
-
-    # The APIs
-    MarkdownUpAPI[] apis
-
-
-group
-
-
-# An API
-struct MarkdownUpAPI
-
-    # The schema action name
-    string name
-
-    # The script function name. If unspecified, use the schema action name.
-    optional string function
-
-    # If true, the API function has a WSGI respone (e.g. `["200 Status", [["Content-Type": "text/plain"]], "Hello!"]`)
-    # Default is false.
-    optional bool wsgi
 ''')

markdown_up-3.3.0/src/markdown_up.egg-info/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: markdown-up
+Version: 3.3.0
+Summary: MarkdownUp is a Markdown viewer
+Author-email: "Craig A. Hobbs" <craigahobbs@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/craigahobbs/markdown-up-py
+Keywords: Markdown,viewer
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Utilities
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: chisel<2.5.0,>=2.4.0
+Requires-Dist: waitress>=3.0.0
+Dynamic: license-file
+
+# markdown-up
+
+[![PyPI - Status](https://img.shields.io/pypi/status/markdown-up)](https://pypi.org/project/markdown-up/)
+[![PyPI](https://img.shields.io/pypi/v/markdown-up)](https://pypi.org/project/markdown-up/)
+[![GitHub](https://img.shields.io/github/license/craigahobbs/markdown-up-py)](https://github.com/craigahobbs/markdown-up-py/blob/main/LICENSE)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/markdown-up)](https://pypi.org/project/markdown-up/)
+
+MarkdownUp is a Markdown viewer.
+
+
+## Install MarkdownUp
+
+Use Python's `pip` to install MarkdownUp as follows:
+
+~~~
+pip install markdown-up
+~~~
+
+
+## View Markdown Files
+
+To start MarkdownUp, open a terminal and run the `markdown-up` application:
+
+~~~
+markdown-up
+~~~
+
+The `markdown-up` application opens the web browser to the MarkdownUp file browser, which allows you
+to view Markdown or HTML files and navigate directories. To view a file, click on its link.
+
+You can view a specific file as follows:
+
+~~~
+markdown-up README.md
+~~~
+
+**Note:** MarkdownUp runs entirely offline. It does not use an external service to render Markdown
+files.
+
+
+## Running MarkdownUp
+
+When you run the `markdown-up` application, in addition to opening the web browser, it starts a
+[chisel](https://pypi.org/project/chisel/)
+backend API application using
+[waitress](https://pypi.org/project/waitress/).
+
+
+### Automatic HTML for Markdown Files
+
+When you run MarkdownUp and click on a Markdown file link, the link navigates to an HTML file that
+renders the Markdown file. Every Markdown file hosted by MarkdownUp has a corresponding `.html` file
+of the same name. For example, if you run MarkdownUp in a directory that has the following Markdown
+files: "README.md" and "CHANGELOG.md". The MarkdownUp service automatically generates "README.html"
+and "CHANGELOG.html" files.
+
+The generated `.html` files are HTML stubs for the
+[MarkdownUp frontend application](https://github.com/craigahobbs/markdown-up#readme).
+All Markdown parsing and rendering are done on the client.
+
+
+### Configuration File
+
+The
+[MarkdownUp Application Configuration File](https://craigahobbs.github.io/markdown-up-py/config.html#var.vName='MarkdownUpConfig'),
+`markdown-up.json`, allows you to enable release mode, set the number of backend server threads, and more.
+
+
+### Command-Line Arguments
+
+The `markdown-up` application has the following command-line arguments:
+
+```
+usage: markdown-up [-h] [-p N] [-t N] [-n] [-r] [-q] [-c FILE] [path]
+
+positional arguments:
+  path                the file or directory to view (default is ".")
+
+options:
+  -h, --help          show this help message and exit
+  -p, --port N        the application port (default is 8080)
+  -t, --threads N     the number of web server threads (default is 8)
+  -n, --no-browser    don't open a web browser
+  -r, --release       release mode (cache statics, remove documentation and index)
+  -q, --quiet         hide access logging
+  -c, --config FILE   the application config filename (default is "markdown-up.json")
+  ```
+
+
+## MarkdownUp Applications
+
+With MarkdownUp, you can write client-rendered frontend applications using
+[BareScript](https://craigahobbs.github.io/bare-script/language/).
+MarkdownUp applications are created by adding `markdown-script` fenced code blocks containing
+[BareScript](https://craigahobbs.github.io/bare-script/language/)
+to a Markdown file and viewing it with the MarkdownUp frontend application. When the Markdown file
+is rendered, the BareScript is executed and its results are rendered in place. For example:
+
+~~~markdown
+# Frontend Hello World
+
+```markdown-script
+markdownPrint('Hello, **World**!!')
+```
+~~~
+
+
+### MarkdownUp Application Reference
+
+[The BareScript Language](https://craigahobbs.github.io/bare-script/language/)
+
+[The BareScript Library](https://craigahobbs.github.io/bare-script/library/)
+
+[MarkdownUp Frontend Examples](https://craigahobbs.github.io/#var.vPage='MarkdownUp')
+
+
+### MarkdownUp Backend Applications
+
+MarkdownUp no longer hosts BareScript backend APIs. To write a backend application in BareScript, use the
+[bare-script](https://pypi.org/project/bare-script/) package's
+[WSGI support](https://craigahobbs.github.io/bare-script-py/wsgi.html).
+
+
+## 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:
+
+~~~
+template-specialize python-template/template/ markdown-up-py/ -k package markdown-up -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapi 1
+~~~

{markdown_up-3.2.0 → markdown_up-3.3.0}/src/markdown_up.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@ README.md
 pyproject.toml
 src/markdown_up/__init__.py
 src/markdown_up/__main__.py
-src/markdown_up/api.py
 src/markdown_up/app.py
 src/markdown_up/main.py
 src/markdown_up.egg-info/PKG-INFO

{markdown_up-3.2.0 → markdown_up-3.3.0}/src/markdown_up.egg-info/requires.txt

@@ -1,3 +1,2 @@
-bare-script<5.2.0,>=5.1.0
 chisel<2.5.0,>=2.4.0
 waitress>=3.0.0