Stacosys (aka STAtic blog COmment SYStem)
Find a file
2022-11-12 21:46:21 +01:00
.github/workflows CI 2022-11-12 21:43:10 +01:00
dbmigration PEP8 2022-04-27 03:12:01 +02:00
docker docker 2021-07-31 05:43:06 +02:00
stacosys lint 2022-11-12 21:43:27 +01:00
tests use configparser and remove profig lib 2022-11-12 12:51:25 +01:00
.gitignore update .gitignore 2022-04-03 18:45:00 +02:00
config.ini remove cron tasks 2022-02-18 18:21:12 +01:00
Dockerfile publish docker image 3.0 2022-02-19 12:12:12 +01:00
flake8.ini PEP8 2022-04-27 03:04:55 +02:00
LICENSE update README, licence GPL v2 upgraded to v3 2021-01-31 17:01:26 +01:00
poetry.lock requires Python 3.10 2022-11-12 12:33:40 +01:00
pyproject.toml requires Python 3.10 2022-11-12 12:33:40 +01:00
README.md Update README badges 2022-04-27 03:17:36 +02:00
run.py black 2022-04-26 20:51:42 +02:00
run.sh move package root 2020-12-27 18:37:07 +01:00
stacosys.code-workspace black 2022-04-26 20:51:42 +02:00
tox.ini use tox for local testing with multiple python versions 2022-01-23 17:04:16 +01:00
whitelist.txt black 2022-04-26 20:51:42 +02:00

GitLicense Python version Code style: black Flask version Peewee version

Build Status - pytest Coverage Status Build status - docker image

Stacosys

Stacosys (aka STAtic blog COmment SYStem) is a fork of Pecosys trying to fix Pecosys design drawbacks and to provide a basic alternative to comment hosting services like Disqus. Stacosys works with any static blog or even a simple HTML page.

Features overview

Stacosys main feature is comment management.

Here is the workflow:

  • Readers submit comments via a comment form embedded in blog pages
  • Blog administrator receives an e-mail notification from Stacosys when a comment is submitted
  • Blog administrator can approve or drop the comment through a simple web admin interface
  • Stacosys stores approved comment in its database.

Privacy concerns: only surname, gravatar id and comment itself are stored in DB. E-mail is optionally requested in submission form to resolve gravatar id but never sent to Stacosys.

Stacosys is more or less localized (english and french).

Technically speaking, how does it work?

Stacosys offers a REST API to retrieve and post comments. Static blog is HTML-based and a piece of JavaScript code interacts with Stacosys using HTTP requests. Each page has a unique id and a request allows retrieving comments for a given page. Similarly, a form request allows to post a comment which is relayed to the administrator by e-mail. For this purpose an SMTP configuration is needed.

Little FAQ

How do you block spammers?

  • Current comment form is basic: no captcha support but protected by a honeypot.

Which database is used?

  • SQLite.

Which technologies are used?

Installation

Build and Dependency management relies on Poetry, but you can also use published releases or Docker image.

Improvements

Stacosys fits my needs, and it manages comments on my blog for a while. I don't have any plan to make big changes, it's more a python playground for me. So I strongly encourage you to fork and enhance the project if you need additional features.