9810c9d5a5
* Move Guix packages to a channel. This patch moves the core Mobilizon Reshare package definition to https://github.com/fishinthecalculator/mobilizon-reshare-guix . |
||
|---|---|---|
| .github/workflows | ||
| api_documentation | ||
| doc | ||
| etc | ||
| mobilizon_reshare | ||
| scripts | ||
| tests | ||
| .coveragerc | ||
| .envrc | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| .pre-commit-hooks.yaml | ||
| LICENSE | ||
| README.md | ||
| README.rst | ||
| channels-lock.scm | ||
| docker-compose.yml | ||
| guix.scm | ||
| manifest.scm | ||
| poetry.lock | ||
| pyproject.toml | ||
| setup.cfg | ||
README.md
The goal of mobilizon_reshare is to provide a suite to reshare Mobilizon events on a broad selection of platforms. This
tool enables an organization to automate their social media strategy in regards
to events and their promotion.
Platforms
mobilizon-reshare currently supports the following social platforms:
- Mastodon
- Telegram
- Zulip
Usage
Scheduling and temporal logic
The tool is designed to work in combination with a scheduler that executes it at
regular intervals. mobilizon_reshare allows fine-grained control over the logic to decide when
to publish an event, with the minimization of human effort as its first priority.
Installation
mobilizon_reshare is distributed through Pypi and DockerHub. Use
$ pip install mobilizon-reshare
to install the tool in your system or virtualenv.
This should install the command mobilizon-reshare in your system. Use it to access the CLI and discover the available
commands and their description.
Guix package
If you run Guix you can install mobilizon-reshare by adding our Guix channel to your .config/guix/channels.scm.
To run mobilizon-reshare from master you can run the following command from the root of the repository:
$ guix time-machine -C channels-lock.scm -- install -L . mobilizon-reshare.git
Run on your local system
Once you have installed mobilizon_reshare you can schedule the refresh from Mobilizon with your system's cron:
$ sudo crontab -l
*/15 * * * * mobilizon-reshare start
Deploying through Docker Compose
To run mobilizon_reshare in a production environment you can use the image published to DockerHub. We also provide an example docker-compose.yml.
Contributing
We welcome contributions from anybody. Currently our process is not structured but feel free to open or take issues through Github in case you want to help us. We have setup some instructions to setup a development environment here.