yax
/
stacosys
mirror of https://github.com/kianby/stacosys
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
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.
402 Commits
1 Branch
11 Tags
1.7 MiB
Python 79.9%
HTML 16%
Makefile 2.1%
Dockerfile 1.6%
Shell 0.4%
 
 
 
 
 
main
2.0
2.0-b1
2.0b2
2.0b3
2.0b4
2.1
2.1-current
3.0
3.1
3.2
3.3
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '25ed2f06e0'
${ noResults }
Go to file
evidencebp 25ed2f06e0 src\stacosys\service\mail.py broad-exception-caught 
Catching Exception might hide unexpected exceptions, like those that might be raised due to future modification.
Therefore, it is recommended to narrow the exceptions.

The method send of the class Mailer catches Exception in line 57.
MIMEText does not raise exceptions (if not using attachments).
See
https://docs.python.org/3/library/email.mime.html

Most code is handled in an inner exception handling.
In order to catch exception from SMTP_SSL I used SMTPException
See
https://docs.python.org/3/library/smtplib.html
 		1 week ago
.github/workflows Upgrade upload-artifact action 2 months ago
dbmigration CQ 1 year ago
docker workaround for container startup 2 years ago
src/stacosys src\stacosys\service\mail.py broad-exception-caught 1 week ago
tests Black formatting 8 months ago
.gitignore Improve code quality 3 months ago
.pylintrc fix pylintrc warnings 1 year ago
Dockerfile Debug container 2 years ago
LICENSE update README, licence GPL v2 upgraded to v3 4 years ago
Makefile Development mode 1 year ago
README.md Update README: poetry replaced by rye 12 months ago
config.ini Replace DB layer Peewee by PyDal 2 years ago
pyproject.toml Upgrade flask 9 months ago
requirements-dev.lock Upgrade dependencies 3 months ago
requirements.lock Upgrade dependencies 3 months ago
stacosys.spec include property files in pyinstaller executable 2 months 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 Rye but you can also use Docker image.

Build executable with pyinstaller

make build

Update dependencies and sync virtual env

rye lock --update-all
rye sync

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.