Skip to main content

A flexible web-based publishing framework

Project description

Publ

A personal publishing platform. Like a static publishing system, only dynamic.

Motivation

I make a lot of different things — comics, music, art, code, games — and none of the existing content management systems I found quite satisfied my use cases. Either they don't allow enough flexibility in the sorts of content that they can provide, or the complexity in managing the content makes it more complicated than simply hand-authoring a site.

I wanted to bring the best of the classic static web to a more dynamic publishing system; scheduled posts, private posts, category-based templates, and built-in support for image renditions (including thumbnails, high-DPI support, and image galleries). And I want to do it all using simple Markdown files organized in a sensible file hierarchy.

Basic tenets

  • Containerized web app that's deployable with little friction (hopefully)
  • Do one thing (present heterogeneous content), do it well (hopefully)
  • Use external tools for site content editing
  • Be CDN-friendly
  • High-DPI images and image sets as first-class citizens
  • Interoperate with everything that's open for interoperation (especially IndieWeb)

See it in action

The main demonstration site is at https://beesbuzz.biz/ — it is of course a work in progress! The documentation site for Publ itself (which is also a work in progress) lives at https://publ.plaidweb.site/

Operating requirements

I am designing this to work in any WSGI-capable environment with a supported version of Python. This means that it will, for example, be deployable on any shared hosting which has Passenger support (such as Dreamhost), as well as on Heroku, Google AppEngine, S3, or any other simple containerized deployment target.

The file system is the ground truth for all site data, and while it does use a database as a content index, the actual choice of database doesn't matter all that much. A typical deployment will use SQLite, but MySQL, Postgres, Oracle, and Cockroach are also supported.

Developing Publ

In order to develop Publ itself, you'll need to install its dependencies; see the getting started guide for more information. In particular, make sure you have compatible versions of Python and Poetry installed, and, if on Windows, you'll probably need to install the Visual C++ build tools.

As far as developing Publ itself goes, cloning this repository and running ./runTests.sh (Linux/macOS/etc.) or wintests.cmd (Windows) should get you up and running. The runtime manual test suite site lives in tests/ (with the actual site content in content/, templates/ and static/).

For developing CLI functionality, you'll have to override the FLASK_APP environment variable to be test_app.py.

Additional resources

The Publ-site repository stores all of the templates, site content, and configuration for the Publ site.

The Publ-templates-beesbuzz.biz repository provides a stripped-down sample site based on my personal homepage.

Authors

In order of first contribution:

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

publ-0.7.28.tar.gz (80.3 kB view details)

Uploaded Source

Built Distribution

publ-0.7.28-py3-none-any.whl (91.6 kB view details)

Uploaded Python 3

File details

Details for the file publ-0.7.28.tar.gz.

File metadata

  • Download URL: publ-0.7.28.tar.gz
  • Upload date:
  • Size: 80.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.6 Darwin/23.0.0

File hashes

Hashes for publ-0.7.28.tar.gz
Algorithm Hash digest
SHA256 1610d3c16878e82f6c5b51b1324cd916d699fbae77853296e498213f2480c8fd
MD5 d9131de8eacb94a6351cc30d75b05128
BLAKE2b-256 e040e815b1c6d6549c5ef065bd617ae8b4bd2b61549062cdc7945942e3880f97

See more details on using hashes here.

File details

Details for the file publ-0.7.28-py3-none-any.whl.

File metadata

  • Download URL: publ-0.7.28-py3-none-any.whl
  • Upload date:
  • Size: 91.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.6 Darwin/23.0.0

File hashes

Hashes for publ-0.7.28-py3-none-any.whl
Algorithm Hash digest
SHA256 09e6fc6694b2fcb29c4604413ecb8ea54481b8854a8380ada8dfe840e3e97591
MD5 b76fa28c37787f3c6d61df6131aa1b0c
BLAKE2b-256 f6f6e8849d81ae93a35cf19539a6068f51d7651e247aaba5ddb8ccd9a8b871cd

See more details on using hashes here.

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