Skip to main content

A simple comment server

Project description

https://framagit.org/erwhann-rouge/sebureem/badges/master/build.svg https://framagit.org/erwhann-rouge/sebureem/badges/master/coverage.svg https://img.shields.io/pypi/v/sebureem.svg https://img.shields.io/pypi/l/sebureem.svg

Sebureem is a small comment server written in Python 3 with the Flask microframework and the Peewee ORM. Comments are storred using the SQLite database.

Sebureem aim to be:

  • Easy to integrate

  • Easy to deploy and configure

Sebureem is the Kotava word for “comments” or “group of comments”.

Important : Sebureem is still in very early stage. It might not be secure and a lot of rough edges are to be expected.

Installation

First run:

pip install sebureem

Create database:

sebureem database --init

Then run your sebureem instance with:

sebureem serve

… or you can specify host and port:

sebureem serve 0.0.0.0 8000

Usage

Just add an iframe containing the following code in your page:

<iframe src="http://<server_url:port>/comments/<topic>" >
    <p>Your browser doesn't support iframes. Comments can't be loaded.</p>
</iframe>

where server_url and port are the address of your instance and topic is the name of the discussion thread you want to add to your webpage.

If the thread doesn’t exist in the database it will be created with the first comment.

Roadmap

Planned features:

  • Angular/Ember/Aurelia web_app

  • Avatar support (Python Cat Avatar Generator ?)

  • Instance federation

  • Admin page

Contributions

Contributions are warmly welcome. See CONTRIBUTING.rst.

Sebureem development occurs here on the Framasoft’s Gitlab instance.

Others repositories (I’m thinking of Github here) are mainly for replication.

License

Sebureem is licensed both under the BSD License and the Cecill-B License.

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

sebureem-0.2.1.tar.gz (21.2 kB view hashes)

Uploaded Source

Built Distribution

sebureem-0.2.1-py3-none-any.whl (23.1 kB view hashes)

Uploaded 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