18 Commits

Author SHA1 Message Date
9d87aab61b go back to lighter red in dark style
contrast is just too low for the "incorporeal red"
2022-01-03 12:40:30 -06:00
35ea94185b unify some of the colors in light vs. dark 2022-01-02 22:55:43 -06:00
69feb0c29c add a 75% max-width class, using it for GOTY? 2022-01-02 22:51:21 -06:00
788a9cbaba use a smaller font for the styled pages 2022-01-02 22:50:04 -06:00
be6d96273c eliminate warnings about how we register the pydot markdown extension 2021-11-03 14:16:18 -05:00
a700470067 document the customization options
more work towards #15
2021-11-01 23:36:10 -05:00
8a62167cea remove some self-specific stuff from settings
implements most, if not all, of #15
2021-11-01 23:27:00 -05:00
4ea824e86f provide some comments explaining the css files 2021-11-01 23:20:42 -05:00
28dbfd45b5 remove bss-specific image from the package
part of the work of #15
2021-11-01 23:20:16 -05:00
1de69dfc70 requirements bump 2021-10-08 07:30:46 -05:00
ccf8434f43 remove a bunch of unnecessary font size styling
in the end, a lot of this doesn't really matter, and right now, I
slightly prefer the site with a touch bigger font, so let's just let the
default do its thing
2021-10-08 07:16:31 -05:00
5aabb79199 call the pydot rendering support 'dot' in package extras 2021-10-08 07:09:21 -05:00
509072ab78 safety in tox: scan requirements for known bad packages 2021-06-24 11:46:56 -05:00
e61c55bed2 handle graphviz parsing errors more cleanly 2021-06-24 11:37:57 -05:00
41a53a2a13 add py39 environment to tox test envs 2021-06-24 11:23:36 -05:00
da055acda6 provide markdown extension to render graphviz
this is server side, and a more standard format, and thus I like it more
than mermaid, which I've been using at work. but, I really wanted a
server-side option (see my manifesto) for drawing relationship graphs,
for D&D stuff of all things.

this adds an optional 'graphviz' feature to package installation which
consequently depends on pydot
2021-06-24 09:46:26 -05:00
1583e3be99 more debugging and catch md misconfigured error 2021-06-24 09:43:00 -05:00
946a557177 correct the license declaration to match LICENSE and README 2021-06-24 08:34:26 -05:00
21 changed files with 299 additions and 142 deletions

View File

@@ -35,6 +35,19 @@ Put content inside `env-py3.8/var/incorporealcms-instance/pages/` and go.
Care is taken to not serve content above the `pages/` dir, even via symlink.
## Configuration
I've tried to keep the software agnostic to my personal domains, logos, etc. There are some settings
you are probably interested in tweaking, by specifying new values in
`incorporealcms-instance/config.py`:
* `TITLE_SUFFIX` is appended to the title of every page, separated from other title content by a
dash.
* `CONTACT_EMAIL` is referred to in error templates.
* `FAVICON` supplies the image used in browser tabs and that kind of thing.
If I missed anything, please let me know.
## Author and Licensing
Written by and copyright Brian S. Stephan (bss@incorporeal.org).

View File

@@ -52,7 +52,7 @@ class Config(object):
# customizations
DEFAULT_PAGE_STYLE = 'light'
TITLE_SUFFIX = 'incorporeal.org'
CONTACT_EMAIL = 'bss@incorporeal.org'
TITLE_SUFFIX = 'example.com'
CONTACT_EMAIL = 'admin@example.com'
# specify FAVICON in your instance config.py to override the suou icon
# specify FAVICON in your instance config.py to override the provided icon

View File

@@ -0,0 +1 @@
"""Markdown extensions."""

View File

@@ -0,0 +1,51 @@
"""Serve dot diagrams inline."""
import base64
import logging
import re
import markdown
import pydot
logger = logging.getLogger(__name__)
class InlinePydot(markdown.Extension):
"""Wrap the markdown prepcoressor."""
def extendMarkdown(self, md):
"""Add InlinePydotPreprocessor to the Markdown instance."""
md.preprocessors.register(InlinePydotPreprocessor(md), 'dot_block', 100)
class InlinePydotPreprocessor(markdown.preprocessors.Preprocessor):
"""Identify dot codeblocks and run them through pydot."""
BLOCK_RE = re.compile(r'~~~pydot:(?P<filename>[^\s]+)\n(?P<content>.*?)~~~', re.DOTALL)
def run(self, lines):
"""Match and generate diagrams from dot code blocks."""
text = '\n'.join(lines)
for match in self.BLOCK_RE.finditer(text):
filename = match.group(1)
dot_string = match.group(2)
# use pydot to turn the text into pydot
graphs = pydot.graph_from_dot_data(dot_string)
if not graphs:
logger.debug("some kind of issue with parsed 'dot' %s", dot_string)
raise ValueError("error parsing dot text!")
# encode the image and provide as an inline image in markdown
encoded_image = base64.b64encode(graphs[0].create_png()).decode('ascii')
data_path = f'data:image/png;base64,{encoded_image}'
inline_image = f'![{filename}]({data_path})'
# replace the image in the output markdown
text = f'{text[:match.start()]}\n{inline_image}\n{text[match.end():]}'
return text.split('\n')
def makeExtension(*args, **kwargs):
"""Provide the extension to the markdown extension loader."""
return InlinePydot(*args, **kwargs)

View File

@@ -49,15 +49,25 @@ def display_page(path):
def handle_markdown_file_path(resolved_path):
"""Given a location on disk, attempt to open it and render the markdown within."""
try:
logger.debug("opening resolved path '%s'", resolved_path)
with app.open_instance_resource(resolved_path, 'r') as entry_file:
mtime = datetime.datetime.fromtimestamp(os.path.getmtime(entry_file.name), get_localzone())
entry = entry_file.read()
logger.debug("resolved path '%s' read", resolved_path)
except OSError:
logger.exception("resolved path '%s' could not be opened!", resolved_path)
abort(500)
else:
try:
md = init_md()
content = Markup(md.convert(entry))
except ValueError:
logger.exception("error parsing/rendering markdown!")
abort(500)
except TypeError:
logger.exception("error loading/rendering markdown!")
abort(500)
logger.debug("file metadata: %s", md.Meta)
parent_navs = generate_parent_navs(resolved_path)

View File

@@ -26,30 +26,6 @@ body {
margin-right: auto;
}
h1 {
font-size: 2em;
}
h2 {
font-size: 1.5em;
}
h3 {
font-size: 1.25em;
}
h4 {
font-size: 1.17em;
}
h5 {
font-size: 1em;
}
h6 {
font-size: .83em;
}
a:link {
font-weight: bold;
text-decoration: none;
@@ -83,7 +59,6 @@ div.header a {
div.content {
font-size: 11pt;
padding: 0 1em;
line-height: 1.5em;
}
@@ -140,6 +115,10 @@ img {
max-width: 50% !important;
}
.img-75 {
max-width: 75% !important;
}
.img-center {
display: block;
margin-left: auto;

View File

@@ -1,11 +1,12 @@
/* common styling via the base.css, used in light and dark */
@import '/static/css/base.css';
html {
color: #CCC;
color: #DDD;
}
body {
background: black;
background: #090909;
}
strong {
@@ -13,7 +14,7 @@ strong {
}
.site-wrap {
background: #111;
background: black;
border: 1px solid #222;
border-top: none;
@@ -61,12 +62,3 @@ blockquote {
background-color: rgba(255, 255, 255, 0.1);
border: 1px solid #333;
}
figure {
background: #222;
border: 1px solid #333;
}
figcaption {
color: #BBB;
}

View File

@@ -1,3 +1,4 @@
/* common styling via the base.css, used in light and dark */
@import '/static/css/base.css';
html {
@@ -5,7 +6,7 @@ html {
}
body {
background: #999;
background: #F6F6F6;
}
strong {
@@ -15,7 +16,7 @@ strong {
.site-wrap {
background: white;
border: 1px solid #ddd;
border: 1px solid #DDD;
border-top: none;
border-bottom: none;
}
@@ -35,38 +36,29 @@ a:hover, a:active {
}
div.header {
background: #EEE;
border-bottom: 1px solid #CCC;
color: #666;
background: #DDD;
border-bottom: 1px solid #DDD;
color: #444;
}
div.header a {
color: #666;
color: #444;
}
table, th, td {
border: 1px solid #ccc;
border: 1px solid #CCC;
}
th {
background: #eee;
background: #CCC;
}
blockquote {
background-color: rgba(120, 120, 120, 0.1);
border: 1px solid #CCC;
border: 1px solid #DDD;
}
.img-frame {
background-color: rgba(0, 0, 0, 0.1);
border: 1px solid #BBB;
}
figure {
background: #EFEFEF;
border: 1px solid #CCCCCC;
}
figcaption {
color: #777777;
border: 1px solid #CCC;
}

View File

@@ -1,4 +1,4 @@
/* specify almost no styling, just fix some image rendering */
.img-25 {
max-width: 25% !important;
}
@@ -6,3 +6,7 @@
.img-50 {
max-width: 50% !important;
}
.img-75 {
max-width: 75% !important;
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

View File

@@ -1,6 +1,7 @@
-r requirements.in
# testing runner, test reporting, packages used during testing (e.g. requests-mock), etc.
pydot
pytest
pytest-cov
@@ -16,6 +17,7 @@ flake8-fixme
flake8-isort
flake8-logging-format
flake8-mutable
safety # check requirements file for issues
# maintenance utilities and tox
pip-tools # pip-compile

View File

@@ -1,31 +1,49 @@
#
# This file is autogenerated by pip-compile
# This file is autogenerated by pip-compile with python 3.8
# To update, run:
#
# pip-compile --output-file=requirements/requirements-dev.txt requirements/requirements-dev.in
#
appdirs==1.4.4
# via virtualenv
attrs==20.3.0
attrs==21.2.0
# via pytest
backports.entry-points-selectable==1.1.0
# via virtualenv
backports.zoneinfo==0.2.1
# via tzlocal
bandit==1.6.2
# via -r requirements/requirements-dev.in
bleach==3.3.0
bleach==4.1.0
# via mdx-linkify
click==7.1.2
certifi==2021.5.30
# via requests
charset-normalizer==2.0.6
# via requests
click==8.0.1
# via
# flask
# pip-tools
coverage==5.5
# safety
coverage[toml]==6.0.1
# via pytest-cov
distlib==0.3.1
distlib==0.3.3
# via virtualenv
dlint==0.11.0
# via -r requirements/requirements-dev.in
filelock==3.0.12
dparse==0.5.1
# via safety
filelock==3.3.0
# via
# tox
# virtualenv
flake8==3.9.2
# via
# -r requirements/requirements-dev.in
# dlint
# flake8-builtins
# flake8-docstrings
# flake8-executable
# flake8-isort
# flake8-mutable
flake8-blind-except==0.2.0
# via -r requirements/requirements-dev.in
flake8-builtins==1.5.3
@@ -42,51 +60,48 @@ flake8-logging-format==0.6.0
# via -r requirements/requirements-dev.in
flake8-mutable==1.2.0
# via -r requirements/requirements-dev.in
flake8==3.9.1
# via
# -r requirements/requirements-dev.in
# dlint
# flake8-builtins
# flake8-docstrings
# flake8-executable
# flake8-isort
# flake8-mutable
flask==1.1.2
flask==2.0.2
# via -r requirements/requirements.in
gitdb==4.0.7
# via gitpython
gitpython==3.1.14
gitpython==3.1.24
# via bandit
idna==3.2
# via requests
iniconfig==1.1.1
# via pytest
isort==5.8.0
isort==5.9.3
# via flake8-isort
itsdangerous==1.1.0
itsdangerous==2.0.1
# via flask
jinja2==2.11.3
jinja2==3.0.2
# via flask
markdown==3.3.4
# via
# -r requirements/requirements.in
# mdx-linkify
markupsafe==1.1.1
markupsafe==2.0.1
# via jinja2
mccabe==0.6.1
# via flake8
mdx-linkify==2.1
# via -r requirements/requirements.in
packaging==20.9
packaging==21.0
# via
# bleach
# dparse
# pytest
# safety
# tox
pbr==5.5.1
pbr==5.6.0
# via stevedore
pep517==0.10.0
pep517==0.11.0
# via pip-tools
pip-tools==6.1.0
pip-tools==6.3.0
# via -r requirements/requirements-dev.in
pluggy==0.13.1
platformdirs==2.4.0
# via virtualenv
pluggy==1.0.0
# via
# pytest
# tox
@@ -96,23 +111,31 @@ py==1.10.0
# tox
pycodestyle==2.7.0
# via flake8
pydocstyle==6.0.0
pydocstyle==6.1.1
# via flake8-docstrings
pydot==1.4.2
# via -r requirements/requirements-dev.in
pyflakes==2.3.1
# via flake8
pyparsing==2.4.7
# via packaging
pytest-cov==2.11.1
# via -r requirements/requirements-dev.in
pytest==6.2.3
# via
# packaging
# pydot
pytest==6.2.5
# via
# -r requirements/requirements-dev.in
# pytest-cov
pytz==2021.1
# via tzlocal
pytest-cov==3.0.0
# via -r requirements/requirements-dev.in
pyyaml==5.4.1
# via bandit
six==1.15.0
# via
# bandit
# dparse
requests==2.26.0
# via safety
safety==1.10.3
# via -r requirements/requirements-dev.in
six==1.16.0
# via
# bandit
# bleach
@@ -122,33 +145,43 @@ smmap==4.0.0
# via gitdb
snowballstemmer==2.1.0
# via pydocstyle
stevedore==3.3.0
stevedore==3.4.0
# via bandit
testfixtures==6.17.1
testfixtures==6.18.3
# via flake8-isort
toml==0.10.2
# via
# pep517
# dparse
# pytest
# tox
tox-wheel==0.6.0
# via -r requirements/requirements-dev.in
tox==3.23.0
tomli==1.2.1
# via
# coverage
# pep517
tox==3.24.4
# via
# -r requirements/requirements-dev.in
# tox-wheel
tzlocal==2.1
# via -r requirements/requirements.in
versioneer==0.19
tox-wheel==0.6.0
# via -r requirements/requirements-dev.in
virtualenv==20.4.3
typing-extensions==3.10.0.2
# via gitpython
tzlocal==3.0
# via -r requirements/requirements.in
urllib3==1.26.7
# via requests
versioneer==0.20
# via -r requirements/requirements-dev.in
virtualenv==20.8.1
# via tox
webencodings==0.5.1
# via bleach
werkzeug==1.0.1
werkzeug==2.0.2
# via flask
wheel==0.36.2
# via tox-wheel
wheel==0.37.0
# via
# pip-tools
# tox-wheel
# The following packages are considered to be unsafe in a requirements file:
# pip

View File

@@ -1,38 +1,38 @@
#
# This file is autogenerated by pip-compile
# This file is autogenerated by pip-compile with python 3.8
# To update, run:
#
# pip-compile --output-file=requirements/requirements.txt requirements/requirements.in
#
bleach==3.3.0
backports.zoneinfo==0.2.1
# via tzlocal
bleach==4.1.0
# via mdx-linkify
click==7.1.2
click==8.0.1
# via flask
flask==1.1.2
flask==2.0.2
# via -r requirements/requirements.in
itsdangerous==1.1.0
itsdangerous==2.0.1
# via flask
jinja2==2.11.3
jinja2==3.0.2
# via flask
markdown==3.3.4
# via
# -r requirements/requirements.in
# mdx-linkify
markupsafe==1.1.1
markupsafe==2.0.1
# via jinja2
mdx-linkify==2.1
# via -r requirements/requirements.in
packaging==20.9
packaging==21.0
# via bleach
pyparsing==2.4.7
# via packaging
pytz==2021.1
# via tzlocal
six==1.15.0
six==1.16.0
# via bleach
tzlocal==2.1
tzlocal==3.0
# via -r requirements/requirements.in
webencodings==0.5.1
# via bleach
werkzeug==1.0.1
werkzeug==2.0.2
# via flask

View File

@@ -18,7 +18,7 @@ setup(
name='incorporeal-cms',
description='Flask project for running https://suou.net (and eventually others).',
url='https://git.incorporeal.org/bss/incorporeal-cms',
license='GPL3',
license='GPLv2+',
author='Brian S. Stephan',
author_email='bss@incorporeal.org',
version=versioneer.get_version(),
@@ -27,4 +27,7 @@ setup(
include_package_data=True,
zip_safe=False,
install_requires=extract_requires(),
extras_require={
'dot': ['pydot'],
},
)

View File

@@ -0,0 +1,39 @@
"""Test graphviz functionality."""
import os
from incorporealcms import create_app
HERE = os.path.dirname(os.path.abspath(__file__))
def app_with_pydot():
"""Create the test app, including the pydot extension."""
return create_app(instance_path=os.path.join(HERE, 'instance'),
test_config={'MARKDOWN_EXTENSIONS': ['incorporealcms.mdx.pydot']})
def test_functional_initialization():
"""Test initialization with the graphviz config."""
app = app_with_pydot()
assert app is not None
def test_graphviz_is_rendered():
"""Initialize the app with the graphviz extension and ensure it does something."""
app = app_with_pydot()
client = app.test_client()
response = client.get('/test-graphviz')
assert response.status_code == 200
assert b'~~~pydot' not in response.data
assert b'data:image/png;base64' in response.data
def test_invalid_graphviz_is_not_rendered():
"""Check that invalid graphviz doesn't blow things up."""
app = app_with_pydot()
client = app.test_client()
response = client.get('/test-invalid-graphviz')
assert response.status_code == 500
assert b'INTERNAL SERVER ERROR' in response.data

View File

@@ -23,7 +23,7 @@ def test_page_that_doesnt_exist(client):
assert response.status_code == 404
assert b'<b><tt>/ohuesthaoeusth</tt></b> does not seem to exist' in response.data
# test the contact email config
assert b'bss@incorporeal.org' in response.data
assert b'admin@example.com' in response.data
def test_files_outside_pages_do_not_get_served(client):
@@ -39,7 +39,7 @@ def test_internal_server_error_serves_error_page(client):
assert response.status_code == 500
assert b'INTERNAL SERVER ERROR' in response.data
# test the contact email config
assert b'bss@incorporeal.org' in response.data
assert b'admin@example.com' in response.data
def test_oserror_is_500(client, app):
@@ -70,28 +70,28 @@ def test_page_with_title_metadata(client):
"""Test that a page with title metadata has its title written."""
response = client.get('/')
assert response.status_code == 200
assert b'<title>Index - incorporeal.org</title>' in response.data
assert b'<title>Index - example.com</title>' in response.data
def test_page_without_title_metadata(client):
"""Test that a page without title metadata gets the default title."""
response = client.get('/no-title')
assert response.status_code == 200
assert b'<title>/no-title - incorporeal.org</title>' in response.data
assert b'<title>/no-title - example.com</title>' in response.data
def test_page_in_subdir_without_title_metadata(client):
"""Test that the title-less page display is as expected."""
response = client.get('/subdir//page-no-title')
assert response.status_code == 200
assert b'<title>/subdir/page-no-title - incorporeal.org</title>' in response.data
assert b'<title>/subdir/page-no-title - example.com</title>' in response.data
def test_page_with_card_metadata(client):
"""Test that a page with opengraph metadata."""
response = client.get('/more-metadata')
assert response.status_code == 200
assert b'<meta property="og:title" content="title for the page - incorporeal.org">' in response.data
assert b'<meta property="og:title" content="title for the page - example.com">' in response.data
assert b'<meta property="og:description" content="description of this page made even longer">' in response.data
assert b'<meta property="og:image" content="http://buh.com/test.img">' in response.data
@@ -100,7 +100,7 @@ def test_page_with_card_title_even_when_no_metadata(client):
"""Test that a page without metadata still has a card with the derived title."""
response = client.get('/no-title')
assert response.status_code == 200
assert b'<meta property="og:title" content="/no-title - incorporeal.org">' in response.data
assert b'<meta property="og:title" content="/no-title - example.com">' in response.data
assert b'<meta property="og:description"' not in response.data
assert b'<meta property="og:image"' not in response.data
@@ -109,7 +109,7 @@ def test_page_with_forced_empty_title_just_shows_suffix(client):
"""Test that if a page specifies a blank Title meta tag explicitly, only the suffix is used in the title."""
response = client.get('/forced-no-title')
assert response.status_code == 200
assert b'<title>incorporeal.org</title>' in response.data
assert b'<title>example.com</title>' in response.data
def test_page_with_redirect_meta_url_redirects(client):

View File

@@ -0,0 +1,12 @@
# test
test
~~~pydot:attack-plan
digraph G {
rankdir=LR
Earth
Mars
Earth -> Mars
}
~~~
more test

View File

@@ -0,0 +1,11 @@
# test
test
~~~pydot:attack-plan
rankdir=LR
Earth
Mars
Earth -> Mars
}
~~~
more test

View File

@@ -20,7 +20,7 @@ def test_markdown_meta_extension_always():
client = app.test_client()
response = client.get('/')
assert response.status_code == 200
assert b'<title>Index - incorporeal.org</title>' in response.data
assert b'<title>Index - example.com</title>' in response.data
def test_custom_markdown_extensions_work():
@@ -68,3 +68,12 @@ def test_favicon_override():
response = client.get('/no-title')
assert response.status_code == 200
assert b'<link rel="icon" href="/media/foo.png">' in response.data
def test_misconfigured_markdown_extensions():
"""Test that a misconfigured markdown extensions leads to a 500 at render time."""
instance_path = os.path.join(HERE, 'instance')
app = create_app(instance_path=instance_path, test_config={'MARKDOWN_EXTENSIONS': 'WRONG'})
client = app.test_client()
response = client.get('/no-title')
assert response.status_code == 500

View File

@@ -9,19 +9,19 @@ from incorporealcms.pages import (generate_parent_navs, instance_resource_path_t
def test_generate_page_navs_index(app):
"""Test that the index page has navs to the root (itself)."""
with app.app_context():
assert generate_parent_navs('pages/index.md') == [('incorporeal.org', '/')]
assert generate_parent_navs('pages/index.md') == [('example.com', '/')]
def test_generate_page_navs_subdir_index(app):
"""Test that dir pages have navs to the root and themselves."""
with app.app_context():
assert generate_parent_navs('pages/subdir/index.md') == [('incorporeal.org', '/'), ('subdir', '/subdir/')]
assert generate_parent_navs('pages/subdir/index.md') == [('example.com', '/'), ('subdir', '/subdir/')]
def test_generate_page_navs_subdir_real_page(app):
"""Test that real pages have navs to the root, their parent, and themselves."""
with app.app_context():
assert generate_parent_navs('pages/subdir/page.md') == [('incorporeal.org', '/'), ('subdir', '/subdir/'),
assert generate_parent_navs('pages/subdir/page.md') == [('example.com', '/'), ('subdir', '/subdir/'),
('Page', '/subdir/page')]
@@ -29,7 +29,7 @@ def test_generate_page_navs_subdir_with_title_parsing_real_page(app):
"""Test that title metadata is used in the nav text."""
with app.app_context():
assert generate_parent_navs('pages/subdir-with-title/page.md') == [
('incorporeal.org', '/'),
('example.com', '/'),
('SUB!', '/subdir-with-title/'),
('page', '/subdir-with-title/page')
]
@@ -39,7 +39,7 @@ def test_generate_page_navs_subdir_with_no_index(app):
"""Test that breadcrumbs still generate even if a subdir doesn't have an index.md."""
with app.app_context():
assert generate_parent_navs('pages/no-index-dir/page.md') == [
('incorporeal.org', '/'),
('example.com', '/'),
('/no-index-dir/', '/no-index-dir/'),
('page', '/no-index-dir/page')
]

View File

@@ -4,7 +4,7 @@
# and then run "tox" from this directory.
[tox]
envlist = begin,py37,py38,coverage,security,lint,bundle
envlist = begin,py37,py38,py39,coverage,security,lint,bundle
[testenv]
# build a wheel and test it
@@ -41,6 +41,11 @@ commands =
commands =
pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
[testenv:py39]
# run pytest with coverage
commands =
pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
[testenv:coverage]
# report on coverage runs from above
skip_install = true
@@ -53,6 +58,7 @@ commands =
# again it seems the most valuable here to run against the packaged code
commands =
bandit {envsitepackagesdir}/incorporealcms/ -r
safety check -r requirements/requirements-dev.txt
[testenv:lint]
# run style checks