Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/collective/collective.mastodon
Mastodon integration for Plone
https://github.com/collective/collective.mastodon
addon mastodon plone plone6
Last synced: 23 days ago
JSON representation
Mastodon integration for Plone
- Host: GitHub
- URL: https://github.com/collective/collective.mastodon
- Owner: collective
- License: gpl-2.0
- Created: 2023-08-24T22:21:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-26T16:25:34.000Z (about 1 year ago)
- Last Synced: 2024-10-15T14:40:58.494Z (about 1 month ago)
- Topics: addon, mastodon, plone, plone6
- Language: Python
- Homepage: https://pypi.org/project/collective.mastodon/
- Size: 198 KB
- Stars: 3
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: docs/contributing.md
- License: LICENSE.GPL
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
collective.mastodon
[](https://pypi.org/project/collective.mastodon/)
[](https://pypi.org/project/collective.mastodon/)
[](https://pypi.org/project/collective.mastodon/)
[](https://pypi.org/project/collective.mastodon/)
[](https://pypi.org/project/collective.mastodon/)
[](https://pypi.org/project/collective.mastodon/)
[](https://github.com/collective/collective.mastodon/actions/workflows/meta.yml)
[](https://github.com/collective/collective.mastodon)
[](https://github.com/collective/collective.mastodon)
**collective.mastodon** is a package providing a [Plone](https://plone.org/) content rules action to post a status to a Mastodon instance.
# Installation
This package supports Plone sites using Volto and ClassicUI.
For proper Volto support, the requirements are:
* plone.restapi >= 8.34.0
* Volto >= 16.10.0
Add **collective.mastodon** to the Plone installation using `pip`:
```bash
pip install collective.mastodon
```
or add it as a dependency on your package's `setup.py`
```python
install_requires = [
"collective.mastodon",
"Plone",
"plone.restapi",
"setuptools",
],
```
## Configuration
### Obtaining an Access Token
Before you can use this package, you have to register an application on Mastodon.
To do so, log in to your account, visit `settings/applications/new` and create the application. (Please select `read` and `write` scopes, and keep the default `Redirect URI`).
Go to the newly created application page and copy the value of `Your access token`.
### Configuring Plone
This package is configured via the `MASTODON_APPS` environment variable which should contain a valid JSON array with your Mastodon Application information.
Each application registration requires the following information:
| Key | Description | Example Value |
| -- | -- | -- |
| name | Identifier for the application | localhost-user |
| instance | URL of your instance, without the trailing slash | http://localhost |
| token | Access token of your Mastodon Application | jutbgrhNDS1EvUvpoHD0ox4a7obSCT9_IpliStv799M |
| user | User on the Mastodon instance. (Only used to generate a friendly name on Plone) | user |
Using the information above, the environment variable would look like:
```shell
MASTODON_APPS='[{"name": "localhost-user","instance":"http://localhost","token":"jutbgrhNDS1EvUvpoHD0ox4a7obSCT9_IpliStv799M","user":"user"}]'
```
### Starting Plone
Now, you can start your local Plone installation with:
```shell
MASTODON_APPS='[{"name": "localhost-user","instance":"http://localhost","token":"jutbgrhNDS1EvUvpoHD0ox4a7obSCT9_IpliStv799M","user":"user"}]' make start
```
or, if you are using a `docker compose` configuration, add the new environment variable under the `environment` key:
```yaml
environment:
- MASTODON_APPS='[{"name": "localhost-user","instance":"http://localhost","token":"jutbgrhNDS1EvUvpoHD0ox4a7obSCT9_IpliStv799M","user":"user"}]'
```
After start-up visit the `Content Rules` Control Panel, and create a new content rule.
No additional configuration is needed for Volto support.
# Contributing
If you want to help with the development (improvement, update, bug-fixing, ...) of `collective.mastodon` this is a great idea!
- [Issue Tracker](https://github.com/collective/collective.mastodon/issues)
- [Source Code](https://github.com/collective/collective.mastodon/)
- [Documentation](https://collective.github.io/collective.mastodon)
We appreciate any contribution and if a release is needed to be done on PyPI, please just contact one of us.
## Local Development
You need a working `python` environment (system, `virtualenv`, `pyenv`, etc) version 3.8 or superior.
Then install the dependencies and a development instance using:
```bash
make build
```
### Update translations
```bash
make i18n
```
### Format codebase
```bash
make format
```
### Run tests
Testing of this package is done with [`pytest`](https://docs.pytest.org/) and [`tox`](https://tox.wiki/).
Run all tests with:
```bash
make test
```
Run all tests but stop on the first error and open a `pdb` session:
```bash
./bin/tox -e test -- -x --pdb
```
Run only tests that match `TestAppDiscovery`:
```bash
./bin/tox -e test -- -k TestAppDiscovery
```
Run only tests that match `TestAppDiscovery`, but stop on the first error and open a `pdb` session:
```bash
./bin/tox -e test -- -k TestAppDiscovery -x --pdb
```
## Translations
This product has been translated into:
- English (Érico Andrei)
- Português do Brasil (Érico Andrei)
# License
The project is licensed under GPLv2.
# One Last Thing
Originally Made in São Paulo, Brazil, with love, by your friends @ Simples Consultoria.
Now maintained by the [Plone Collective](https://github.com/collective)