Microblog server backend
Project description
Microblog server
Python backend for a low-volume personal microblog.
Input server (Telegram bot) waits for user to post new microblog entries and saves them to storage (git repo). Entries can be fetched from storage via provided Python library. There is also a plugin for Pelican to render microblog entries on a static web site.
Input server and storage engine should be easy to replace or add new implementations in future.
Installation
-
Python package is published at PyPI: https://pypi.org/project/microblog-server/
- Install with
pip install microblog-server
- Make sure that
git
is available in $PATH
- Install with
-
Ready to go Docker image is also available
Usage
Running input server
- Commandline entrypoint:
microblog
- Configuration is done via environment variables:
MICROBLOG_STORAGE
: Path to a local checkout of git repository that stores the microblogMICROBLOG_TOKEN
: Telegram bot tokenMICROBLOG_USERS
: Comma-separated list of Telegram accounts allowed to interact with the bot
Using Python library to read microblog from storage
See the source code
Rendering static web site
See Pelican docs for general information on using static site generator.
Plugin configuration:
# pelicanconf.py
import microblog.pelican
import microblog.storage
PLUGINS = [
microblog.pelican,
]
MICROBLOG = microblog.storage.GitStorage('./path/to/local/copy/of/git/repo/')
Your theme is expected to provide the following templates:
Check plugin source for further information. See author's site configuration for further examples.
License and copyright
Copyright 2022 Vitaly Potyarkin
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the 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
Built Distribution
Hashes for microblog_server-1.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ff71e8b13028470ec63365aae83992249c50e93d8714219d0ec7791efda4e6d |
|
MD5 | 23015c4520c0af732d23e98f919c2e5b |
|
BLAKE2b-256 | 634c5a9700d125efb1c3d1026b124eaac59771949eaa00c72a9d199edc651de0 |