Static sites need a Commenting System
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Yax cfe2da56c0 Revert "Code Quality"
This reverts commit 6e46eea814.
12 months ago
.github/workflows Replaced by Makefile / pylint + LSP pyright 2 years ago
dbmigration PEP8 3 years ago
docker workaround for container startup 2 years ago
stacosys Revert "Code Quality" 12 months ago
tests finalize 3.3 release 2 years ago
.gitignore gitignore 2 years ago
.pylintrc pylint fixes 2 years ago
Dockerfile Debug container 2 years ago
LICENSE update README, licence GPL v2 upgraded to v3 4 years ago
Makefile finalize 3.3 release 2 years ago
README.md README 2 years ago
build.sh Build py executable 1 year ago
config.ini Replace DB layer Peewee by PyDal 2 years ago
flake8.ini PEP8 3 years ago
poetry.lock Poetry update 1 year ago
poetry.toml set python version with pyenv. Create virtual env inside project 2 years ago
pyproject.toml python <3.11 allowed 2 years ago
run.sh move run.py 2 years ago
stacosys.spec pyinstall spec file handling ninja templates 2 years ago
whitelist.txt black 3 years ago

README.md

License: GPL v3 Python version Code style: black Flask 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.

Build executable with pyinstaller

poetry run pyinstaller stacosys.spec 

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.