Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Maurizio Paglia authored Nov 30, 2022
1 parent d8e711d commit e8dad3c
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
# Pelican-toot
A Pelican plugin to publish content on Mastodon

## THIS IS A VERY EARLY STAGE OF DEVELOPMENT
## DO NOT USE!!

====================================================================================
TEST - TEST - TEST
====================================================================================

Hacked from [Pelican-tweet](https://github.com/mpaglia0/Pelican-tweet).

Needs Python > 3.0
Expand All @@ -22,14 +15,27 @@ Then it tries to post all eligible articles to Mastodon and - if post routine re

On every further run it matches the actual articles list with the list in `posted_on_Mastodon.txt` file and posts only new articles (and writes them in `posted_on_Mastodon.txt`).

*Pelican-toot* is at its very first stage of development, but it is already usable in product environments.

This release can publish:

- Title of article
- Body of article
- hashtag(s) if any

## Mastodon APIs

This plugin depends on [Mastodon.py](https://github.com/halcy/Mastodon.py).

In order to publish on Mastodon you need to enter in `publishconf.py` the following information:

TODO
``` python
MASTODON_CONSUMER_KEY = ''
...
MASTODON_BASE_URL = 'URL of your Mastodon instance. For example https://mastodon.social'
MASTODON_USERNAME = 'Your username for Mastodon login'
MASTODON_PASSWORD = 'You password for Mastodon login'
```
There is no need to register an app in your Mastodon profile because *Pelican-toot* will do it for you!

This plugin depends on [Mastodon.py](https://github.com/halcy/Mastodon.py).
On every run *Pelican-toot* looks for a file called `pelicantoot_clientcred.secret` and - if it is not found - it gets in touch with Mastodon, creates an app called *PelicanToot* and writes API keys and other necessary information in this file.

If you cancel this file *Pelican-toot* will create another app (this could be done in case of problem despite the fact Mastodon advise this is NOT a good behaviour since app should be created only once).

0 comments on commit e8dad3c

Please sign in to comment.