qrn 0.10.0__tar.gz

qrn-0.10.0/.gitignore

@@ -0,0 +1,135 @@
+# Doctrine specific files
+generated.py
+
+# Editor files
+*.sw[onp]
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

qrn-0.10.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Russ Olsen
+
+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.

qrn-0.10.0/Makefile

@@ -0,0 +1,21 @@
+
+PYTHON=pypy3
+DST_DIR=dist
+
+build: $(DST_DIR)
+	$(PYTHON) -m build
+
+$(DST_DIR):
+	mkdir -f $@
+
+package:
+	$(PYTHON) -m build
+
+install_local:
+	 $(PYTHON) -m pip install .
+
+upload_test:
+	twine upload -r testpypi dist/*
+
+clean:
+	rm -rf $(DST_DIR)/*

qrn-0.10.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.1
+Name: qrn
+Version: 0.10.0
+Summary: A simple static site generator
+Project-URL: Homepage, https://github.com/russolsen/qrn
+Project-URL: Bug Tracker, https://github.com/russolsen/qrn/issues
+Author-email: Russ Olsen <russ@russolsen.com>
+License: MIT License
+        
+        Copyright (c) 2022 Russ Olsen
+        
+        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.
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# QRN: A simple, highly opinionated static site generator
+
+QRN is a static site generator that is as simple as I can make
+it while still being useful. QRN assumes that most of your content
+is in markdown format, that you are using sass/scss or plain old css
+for styling. QRN is also geared towards modest sized content, the
+kind of thing you might find in a personal blog.
+
+QRN also supports a simple but flexible layout/templating system
+that let's you specify a standard HTML "frame" around your content
+and also embed executable Python code in the content.
+
+A key feature of QRN is that it has very few external dependencies.
+QRN is written in a fairly generic Python 3 and requires:
+
+* The PyYAML Python library.
+* An external program that turns markdown into HTML (currently pandoc).
+* And external program that turns scss/sass into css (currently sass).
+
+That's it. What this means is that QRN is easy to set up and
+(I hope) will continue to work over time as libararies and packages
+change.
+
+## What does QRN mean?
+
+Ham radio operators use a [shorthand code](https://fieldradio.org/ham-radio-q-codes)
+that has its origins in the early days of telegraphy. QRN is the code that means
+"I am troubled by static noise."
+
+## Using QRN
+
+QRN works like most static site generators: You prepare a directory with
+roughly the content you want to show up in your final site. When you run
+QRN it transforms your source content into a final output site that you can
+then deploy. The value of QRN is that it performs various transformation as
+it does the copying:
+
+* QRN knows how to tranform markdown files into html.
+* QRN knows how to do "include" processing on your content so 
+that you can write the common parts of your site once.
+
+The key idea behind QRN is that it is extremely opinionated about a few
+things -- mostly around a some key naming conventions and how those
+files are processed into your final static webstite.
+
+Specifically: 
+
+* QRN wants you to put the source for your site under a directory called `src`.
+* QRN generally ignores files and directories whose names start with an underbar (.e.g. `src/_save`).
+* QRN wants you to put the source for all included files and layouts (see below) in `src/_layouts`.
+* When you run QRN it will put the resulting processed, read-to-go site in a directory called `build`.
+* QRN will run all files with a `.html` or `.xml` extension through the `epy` processor (see below).
+* QRN will run all files with a `.haml` extension through the `paml` processor (see below).
+* QRN will run all files with a `.md` extension through the `epy` processor and then convert it to HTML. 
+* QRN will run all files with a `.sass` or `.scss` extension through the `sass` processor.
+* Otherwise, QRN will just copy files from `src` to `build`.
+
+## File headers and layouts.
+
+In general, QRN will recognize YAML headers at the beginning of .md, .html, .xml and .haml files. The headers
+are set off from the file content with three dashes:
+
+```
+---
+title: A simple html file.
+date: klsdfklj
+---
+<html>
+  <body>
+    <title>A simple html file.</title>
+  </body>
+</html>
+```
+
+## The EPy Processor
+
+As mentioned above, QRN runs .md, .html and .xml files through the Embedded Python (or EPy) processor.
+EPy allows you to embed code that is evaluated at site build time in your content. 
+EPy uses the common `text <%= some_code() %> more text` syntax, reminencent of
+[Embedded Ruby](https://en.wikipedia.org/wiki/ERuby). Specifically:
+
+* `<%= some_code() %>` will insert the result of evaluating the Python code into the text. Thus `1 <%= 100/50 %> 3`
+will result in `1 2 3`.
+* `<%! other_code() !%>` will simply evaluate the Python code and ignore the result.
+
+Python's indentation based approach to syntax presents a special challenge to EPy: Requiring significant whitespace
+in embedded code would be error prone and confusing. Instead, EPy strips off leading whitespace and relies on the
+training `:`'s to open code blocks and a special <%! end %> directive to  close them. Here, for example is a
+loop in EPy:
+
+```
+<%! for x in range(1): %>
+The number is <%= x %>
+<%! end %>
+```
+
+And an `if` statement in EPy:
+
+```
+<%! count = 0 %>
+<%! if count: %>
+The count is non-zero.
+<%! else: %>
+The counts is zero.
+<%! end %>
+```
+
+Note that the `<%! end %>` does not appear in the actual Python code. It
+is just a marker that the `if` or `for` has ended.
+
+## The Paml Processor
+
+Similarly, QRN includes a "Paml" processor. Paml is like Haml, but it uses Python
+in place of Ruby. Other than that syntax is more or less Haml. Here's an example:
+
+```
+---
+kind: partial
+---
+.twelve.columns
+  %ul.menu
+    %li.menu
+      %a{"href": "/index.html"} Contents
+     %li.menu
+      %a{"href": "/credit.html"} Credits
+    %li.menu
+      %a{"href": "/license.html"} License
+    %li.menu
+      %a{"href": "/205-0.txt"} Original File
+```

qrn-0.10.0/README.md

@@ -0,0 +1,130 @@
+# QRN: A simple, highly opinionated static site generator
+
+QRN is a static site generator that is as simple as I can make
+it while still being useful. QRN assumes that most of your content
+is in markdown format, that you are using sass/scss or plain old css
+for styling. QRN is also geared towards modest sized content, the
+kind of thing you might find in a personal blog.
+
+QRN also supports a simple but flexible layout/templating system
+that let's you specify a standard HTML "frame" around your content
+and also embed executable Python code in the content.
+
+A key feature of QRN is that it has very few external dependencies.
+QRN is written in a fairly generic Python 3 and requires:
+
+* The PyYAML Python library.
+* An external program that turns markdown into HTML (currently pandoc).
+* And external program that turns scss/sass into css (currently sass).
+
+That's it. What this means is that QRN is easy to set up and
+(I hope) will continue to work over time as libararies and packages
+change.
+
+## What does QRN mean?
+
+Ham radio operators use a [shorthand code](https://fieldradio.org/ham-radio-q-codes)
+that has its origins in the early days of telegraphy. QRN is the code that means
+"I am troubled by static noise."
+
+## Using QRN
+
+QRN works like most static site generators: You prepare a directory with
+roughly the content you want to show up in your final site. When you run
+QRN it transforms your source content into a final output site that you can
+then deploy. The value of QRN is that it performs various transformation as
+it does the copying:
+
+* QRN knows how to tranform markdown files into html.
+* QRN knows how to do "include" processing on your content so 
+that you can write the common parts of your site once.
+
+The key idea behind QRN is that it is extremely opinionated about a few
+things -- mostly around a some key naming conventions and how those
+files are processed into your final static webstite.
+
+Specifically: 
+
+* QRN wants you to put the source for your site under a directory called `src`.
+* QRN generally ignores files and directories whose names start with an underbar (.e.g. `src/_save`).
+* QRN wants you to put the source for all included files and layouts (see below) in `src/_layouts`.
+* When you run QRN it will put the resulting processed, read-to-go site in a directory called `build`.
+* QRN will run all files with a `.html` or `.xml` extension through the `epy` processor (see below).
+* QRN will run all files with a `.haml` extension through the `paml` processor (see below).
+* QRN will run all files with a `.md` extension through the `epy` processor and then convert it to HTML. 
+* QRN will run all files with a `.sass` or `.scss` extension through the `sass` processor.
+* Otherwise, QRN will just copy files from `src` to `build`.
+
+## File headers and layouts.
+
+In general, QRN will recognize YAML headers at the beginning of .md, .html, .xml and .haml files. The headers
+are set off from the file content with three dashes:
+
+```
+---
+title: A simple html file.
+date: klsdfklj
+---
+<html>
+  <body>
+    <title>A simple html file.</title>
+  </body>
+</html>
+```
+
+## The EPy Processor
+
+As mentioned above, QRN runs .md, .html and .xml files through the Embedded Python (or EPy) processor.
+EPy allows you to embed code that is evaluated at site build time in your content. 
+EPy uses the common `text <%= some_code() %> more text` syntax, reminencent of
+[Embedded Ruby](https://en.wikipedia.org/wiki/ERuby). Specifically:
+
+* `<%= some_code() %>` will insert the result of evaluating the Python code into the text. Thus `1 <%= 100/50 %> 3`
+will result in `1 2 3`.
+* `<%! other_code() !%>` will simply evaluate the Python code and ignore the result.
+
+Python's indentation based approach to syntax presents a special challenge to EPy: Requiring significant whitespace
+in embedded code would be error prone and confusing. Instead, EPy strips off leading whitespace and relies on the
+training `:`'s to open code blocks and a special <%! end %> directive to  close them. Here, for example is a
+loop in EPy:
+
+```
+<%! for x in range(1): %>
+The number is <%= x %>
+<%! end %>
+```
+
+And an `if` statement in EPy:
+
+```
+<%! count = 0 %>
+<%! if count: %>
+The count is non-zero.
+<%! else: %>
+The counts is zero.
+<%! end %>
+```
+
+Note that the `<%! end %>` does not appear in the actual Python code. It
+is just a marker that the `if` or `for` has ended.
+
+## The Paml Processor
+
+Similarly, QRN includes a "Paml" processor. Paml is like Haml, but it uses Python
+in place of Ruby. Other than that syntax is more or less Haml. Here's an example:
+
+```
+---
+kind: partial
+---
+.twelve.columns
+  %ul.menu
+    %li.menu
+      %a{"href": "/index.html"} Contents
+     %li.menu
+      %a{"href": "/credit.html"} Credits
+    %li.menu
+      %a{"href": "/license.html"} License
+    %li.menu
+      %a{"href": "/205-0.txt"} Original File
+```

qrn-0.10.0/examples/simple/Makefile

@@ -0,0 +1,24 @@
+SITE_SCRIPT=static.py
+PYTHON=pypy3
+DST_DIR=build
+PORT=7723
+
+.PHONY: release
+release: clean build
+
+r: release
+
+.PHONY: build
+build:
+	$(PYTHON) static.py
+
+.PHONY: serve
+serve:
+	$(PYTHON) -m http.server --directory $(DST_DIR) $(PORT)
+
+s: serve
+
+.PHONY: clean
+clean:
+	rm -rf $(DST_DIR)/*
+	rm -f static.log

qrn-0.10.0/examples/simple/src/_layouts/_footer.haml

@@ -0,0 +1,15 @@
+---
+kind: partial
+---
+- this_no = int(self.page.get('number', -1))
+- previous_no = find_page('number', this_no - 1)
+- next_no = find_page('number', this_no + 1)
+.container.footer
+  - if previous_no:
+    .navarrow#previous
+      <
+      = anchor_for_page( previous_no )
+  - if next_no:
+    .navarrow#next
+      = anchor_for_page( next_no )
+      > 

qrn-0.10.0/examples/simple/src/_layouts/_head.haml

@@ -0,0 +1,19 @@
+---
+kind: partial
+---
+%head
+  %meta{"charset": "utf-8"}
+  %title= page.site.title
+
+  %meta{'name': 'description' ,'content':  ''}
+  %meta{'name': 'author' ,'content': ''}
+
+  %meta{'name': 'viewport', 'content':  'width=device-width, initial-scale=1, maximum-scale=1'}
+
+  %link{'rel': "stylesheet", 'href':  '/stylesheets/styles.css'}
+
+  %link{"rel": "shortcut icon",'href': "images/favicon.ico"}
+  %link{"rel": "apple-touch-icon",'href': "images/apple-touch-icon.png"}
+  %link{"rel": "apple-touch-icon",'sizes': "72x72",'href': "images/apple-touch-icon-72x72.png"}
+  %link{"rel": "apple-touch-icon",'sizes': "114x114",'href':"images/apple-touch-icon-114x114.png"}
+

qrn-0.10.0/examples/simple/src/_layouts/_masthead.haml

@@ -0,0 +1,6 @@
+---
+kind: partial
+---
+%h1.logo= page['site']['title']
+%h2.author= page.author
+= include('_menu.haml')

qrn-0.10.0/examples/simple/src/_layouts/_menu.haml

@@ -0,0 +1,13 @@
+---
+kind: partial
+---
+.twelve.columns
+  %ul.menu
+    %li.menu
+      %a{"href": "/index.html"} Contents
+     %li.menu
+      %a{"href": "/credit.html"} Credits
+    %li.menu
+      %a{"href": "/license.html"} License
+    %li.menu
+      %a{"href": "/205-0.txt"} Original File

qrn-0.10.0/examples/simple/src/_layouts/_sidebar.haml

@@ -0,0 +1,4 @@
+---
+kind: partial
+---
+%p Sidebar

qrn-0.10.0/examples/simple/src/_layouts/article.haml

@@ -0,0 +1,21 @@
+---
+kind: layout
+---
+%html
+  = include('_head.haml')
+  %body
+    #header
+      %a{"href": "/"}
+        = self.page.site.title
+    .main
+      %h1#articleTitle
+        = self.page.title
+      #content
+        #authors
+          %a{"href": "https://example.com"}= self.page.author
+          ,
+          = self.page.date
+        #article
+          = include(self.path, full_path=True)
+        #footer
+          = include('_footer.haml')

qrn-0.10.0/examples/simple/src/_layouts/default.haml

@@ -0,0 +1,22 @@
+---
+kind: layout
+---
+%html
+  = include('_head.haml')
+  %body
+    .container.page
+      .row
+        .twelve.columns.header
+          = include('_masthead.haml')
+      .row
+        .row
+          .twelve.columns.left.main
+            %h2= self.page.title
+            %h3
+              By
+              = self.page.author
+            .text
+              = include(self.path, full_path=True)
+        .row
+          .twelve.columns.left.footer
+            = include('_footer.haml')