| Name | signalblast JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | None |
| Summary | Broadcast bot for Signal |
| upload_time | 2024-10-30 21:49:56 |
| maintainer | None |
| docs_url | None |
| author | Era Dorta |
| requires_python | >=3.10 |
| license | None |
| keywords |
bot
broadcast
signal
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# signalblast
Signalblast is a tool to send encrypted messages anonymously over [Signal](https://www.signal.org/) to a subscriber list. The sender does not know who the subscribers in the list are, nor the subscribers know who the sender is.
A server is required to host the bot, find instructions on how the set it up below.
The idea for this bot came from [Signalboost](https://web.archive.org/web/https://signalboost.info/), which unfortunately is no longer alive.
## Usage
Once the bot is up and running, several commands are available:
* `!subscribe` send this to sign up to the list
* `!broadcast` after subscribing any message preceded by this will be broadcasted to every subscriber
* `!unsubscribe` to stop receiving messages
* `!help` to be reminded of which commands are available
* `!admin` send a message only to the list admin, useful for getting technical support
## Installation
* Install [docker](https://www.docker.com/).
* Set up signalbot as specified [here](https://github.com/filipre/signalbot)
* Create a new virtual environment, [uv](https://docs.astral.sh/uv/) is recommended
* Install with `pip install signalblast`
* Run via `python -m signalblast.main`
## Development
* Set up docker and signalbot as specified in the [installation](#installation) section.
* Clone the repo
* Install [uv](https://docs.astral.sh/uv/)
* Install the repo and the dependencies in a new virtual environment with `uv sync`
* Install the pre-commit hook `uv run pre-commit install`
* Run
* Directly via `uv run python -m signalblast.main`
* Via systemd with `systemd/signalblast.service`
* Run once with the password in the env file.
* From there one, the password is stored encrypted and it can be removed from the env file
## Roadmap
* Fix docker deployment
* Fix the `docker-compose.yaml` files and use signalblast version from hatch
* Build docker images for `arm` and `x86` targets using the github CI
* Make instructions clearer and add pictures to the readme
Raw data
{
"_id": null,
"home_page": null,
"name": "signalblast",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Bot, Broadcast, Signal",
"author": "Era Dorta",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/82/ad/b822ecaeea32b40d88a092d71e1bf65c64ad1e9a0f395ec70a71a3304d62/signalblast-0.6.0.tar.gz",
"platform": null,
"description": "# signalblast\n\nSignalblast is a tool to send encrypted messages anonymously over [Signal](https://www.signal.org/) to a subscriber list. The sender does not know who the subscribers in the list are, nor the subscribers know who the sender is.\n\nA server is required to host the bot, find instructions on how the set it up below.\n\nThe idea for this bot came from [Signalboost](https://web.archive.org/web/https://signalboost.info/), which unfortunately is no longer alive.\n\n## Usage\n\nOnce the bot is up and running, several commands are available:\n* `!subscribe` send this to sign up to the list\n* `!broadcast` after subscribing any message preceded by this will be broadcasted to every subscriber\n* `!unsubscribe` to stop receiving messages\n* `!help` to be reminded of which commands are available\n* `!admin` send a message only to the list admin, useful for getting technical support\n\n## Installation\n\n* Install [docker](https://www.docker.com/).\n* Set up signalbot as specified [here](https://github.com/filipre/signalbot)\n* Create a new virtual environment, [uv](https://docs.astral.sh/uv/) is recommended\n* Install with `pip install signalblast`\n* Run via `python -m signalblast.main`\n\n## Development\n\n* Set up docker and signalbot as specified in the [installation](#installation) section.\n* Clone the repo\n* Install [uv](https://docs.astral.sh/uv/)\n* Install the repo and the dependencies in a new virtual environment with `uv sync`\n* Install the pre-commit hook `uv run pre-commit install`\n* Run\n * Directly via `uv run python -m signalblast.main`\n * Via systemd with `systemd/signalblast.service`\n * Run once with the password in the env file.\n * From there one, the password is stored encrypted and it can be removed from the env file\n\n## Roadmap\n* Fix docker deployment\n * Fix the `docker-compose.yaml` files and use signalblast version from hatch\n * Build docker images for `arm` and `x86` targets using the github CI\n* Make instructions clearer and add pictures to the readme\n",
"bugtrack_url": null,
"license": null,
"summary": "Broadcast bot for Signal",
"version": "0.6.0",
"project_urls": null,
"split_keywords": [
"bot",
" broadcast",
" signal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7cde7a573339d333390ecd62c9237285321f872348cc4e5fb7b6f3c42237faac",
"md5": "ecaab75c02cfa0a3cc454881f9225bb8",
"sha256": "99c29641ab636425d5c4f70fa92ede4f7502c60941ac251efcd582338497b3c3"
},
"downloads": -1,
"filename": "signalblast-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ecaab75c02cfa0a3cc454881f9225bb8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 33014,
"upload_time": "2024-10-30T21:49:54",
"upload_time_iso_8601": "2024-10-30T21:49:54.712540Z",
"url": "https://files.pythonhosted.org/packages/7c/de/7a573339d333390ecd62c9237285321f872348cc4e5fb7b6f3c42237faac/signalblast-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "82adb822ecaeea32b40d88a092d71e1bf65c64ad1e9a0f395ec70a71a3304d62",
"md5": "08216623f1185a4054b5f2ca0a8ea9a4",
"sha256": "e3381e9aa6cab1f6e1940492ae76a4fe04ae649f8dd56bce4568158ac67ef33a"
},
"downloads": -1,
"filename": "signalblast-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "08216623f1185a4054b5f2ca0a8ea9a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 62179,
"upload_time": "2024-10-30T21:49:56",
"upload_time_iso_8601": "2024-10-30T21:49:56.166661Z",
"url": "https://files.pythonhosted.org/packages/82/ad/b822ecaeea32b40d88a092d71e1bf65c64ad1e9a0f395ec70a71a3304d62/signalblast-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 21:49:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "signalblast"
}
