Skip to main content

ViloLog: Simple blogging engine, built atop Vilo and PogoDB.

Project description

ViloLog

Simple blogging engine, built atop Vilo and PogoDB.

Installation

pip install vilolog

ViloLog builds a pure WSGI appliation. To run that application, you'll need Gunicorn, Waitress or another WSGI server. Gunicorn is installable via:

pip install gunicorn

Usage

Minimal Setup:

Pass a Postgres connection string to vilolog.buildApp(.) to create your blog.

Create module blog.py:

import vilolog;
app = vilolog.buildApp("postgres://...dsn..");
wsgi = app.wsgi;

Above, app is a Vilo app-container, and wsgi is the corresponding pure-WSGI callable. To run wsgi via Gunicorn:

gunicorn blog:wsgi

Then, visit localhost:8000/_setup in your preferred browser to complete setup.

Configuring vilolog.buildApp(.):

vilolog.buildApp(.) accepts a number of parameters, only the first of which is required:

  • pgUrl (required): Postgres connection string.
  • blogTitle: Self explanatory. (Default: "My ViloLog Blog")
  • blogDescription: Self explanatory. (Default: "Yet another ViloLog blog.")
  • footerLine: Footer attribution line. (Default: "Powered by ViloLog.")
  • cookieSecret (recommended): Secret string for cookie signing.
  • antiCsrfSecret (recommended): Secret string for signing anti-CSRF token. (Default: Random UUID.)
  • themeDir: Path to custom theme directory. (More on this later.) (Default: Random UUID.)
  • devMode: Boolean, indicating if in development mode. (Default: False)
  • redirectMap: Dictionary, mapping from source path to target path. (Default: {}, i.e. no redirects.)

Note: While only pgUrl is required, passing cookieSecret and antiCsrfSecret is highly recommended.

Nascent Stage

ViloLog is currently in a nascent stage. As work progresses, we'll be adding docs, screenshots, theming, etc.

Licensing

Copyright (c) 2020 Polydojo, Inc.

Software Licensing:
The software is released "AS IS" under the GNU GPLv3+, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Kindly see LICENSE.txt for more details.

No Trademark Rights:
The above software licensing terms do not grant any right in the trademarks, service marks, brand names or logos of Polydojo, Inc.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vilolog-0.0.3.tar.gz (25.6 kB view hashes)

Uploaded Source

Built Distribution

vilolog-0.0.3-py2.py3-none-any.whl (29.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page