diff --git a/.gitignore b/.gitignore index f5189cf..90063a8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ docs/build/ __pycache__ feedlist +data *.swp *.pyc *.db @@ -8,3 +9,5 @@ feedlist *.txt *.bck *.png +*.yml +.env diff --git a/CHANGELOG b/CHANGELOG index ce71f4a..55a14f7 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,14 @@ +## [0.17] - 2021-03-26 +### Changed +- fix install bug while installing from sources +- bump changelog + +## [0.16] - 2020-12-09 +### Added +- scripts/register_feed2toot_app: --client-credentials-file option to change the filename in which the client credentials are stored +- scripts/register_feed2toot_app: --user-credentials-file option to change the filename in which the client credentials are stored +- scripts/register_feed2toot_app: --name to change the Mastodon app name + ## [0.15] - 2020-12-07 ### Changed - maintenance version @@ -5,6 +16,7 @@ - update copyrigth - update author email + ## [0.14] - 2019-12-31 ### Added - support for line breaks in toots diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..c6ca6e7 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,13 @@ +FROM python:3.7-bullseye + +ADD . /app +WORKDIR /app + +RUN python3 setup.py install; \ + chmod +x docker_entrypoint.sh; \ + mkdir -p /data /root/.config; \ + rm -rf docke.yml + +WORKDIR /data + +CMD ["/app/docker_entrypoint.sh"] diff --git a/README.md b/README.md index 86ea752..dc85036 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,45 @@ +# Feed2Toot Docker + +Feed2Toot Docker is a fork of [chaica/feed2toot](https://gitlab.com/chaica/feed2toot) that allows for simple deployment over Docker. In the future I'll try to add other useful features. + +### Usage + +With Docker Compose: +```yaml +version: '3' + +services: + feed2toot: + image: gitea.massivebox.net/massivebox/feed2toot-docker:latest + environment: + - USERNAME=sampleusername@sampleinstance.url + - PASSWORD=samplepassword + - INSTANCE=https://sampleinstance.url + restart: always + volumes: + - ./data:/data +``` +Insert your full username (including the part with your homeserver's address), password and instance URL where required. +You also need to create a working `feed2toot.ini` in the `./data` folder. See the [upstream docs](`https://feed2toot.readthedocs.io/en/latest/configure.html#create-feed2toot-configuration`) for the guide. + +After the first successful run, you can remove the entire `environment` block if you want, however, if you delete and re-create the container, you will need to put it back. + +### Support + +Don't ask the upstream developers for help, if something is broken it's more likely that it is my fault. +You can get support by opening an [issue](https://gitea.massivebox.net/massivebox/feed2toot-docker/issues), or by [contacting me](https://massivebox.net/contact.html), or in the [Matrix support room](https://matrix.to/#/#support:massivebox.net). + ### Feed2toot -Feed2toot automatically parses rss feeds, identifies new posts and posts them on the [Mastodon](https://mastodon.social) social network. -For the full documentation, [read it online](https://feed2toot.readthedocs.io/en/latest/). - -If you would like, you can [support the development of this project on Liberapay](https://liberapay.com/carlchenet/). -Alternatively you can donate cryptocurrencies: +The following links and addresses are the upstream developers'. I don't want donations for this project, but I encourage you to donate to them. +- [Liberapay](https://liberapay.com/carlchenet/) - BTC: 1AW12Zw93rx4NzWn5evcG7RNNEM2RSLmAC - XMR: 43GGv8KzVhxehv832FWPTF7FSVuWjuBarFd17QP163uxMaFyoqwmDf1aiRtS5jWgCiRsi73yqedNJJ6V1La2joznKHGAhDi -### Quick Install - -* Install Feed2toot from PyPI - - # pip3 install feed2toot - -* Install Feed2toot from sources - *(see the installation guide for full details) - [Installation Guide](http://feed2toot.readthedocs.io/en/latest/install.html)* - - - # tar zxvf feed2toot-0.15.tar.gz - # cd feed2toot - # python3 setup.py install - # # or - # python3 setup.py install --install-scripts=/usr/bin - -### Create the authorization for the Feed2toot app - -* Just launch the following command:: - - $ register_feed2toot_app - -### Use Feed2toot - -* Create or modify feed2toot.ini file in order to configure feed2toot: - - [mastodon] - instance_url=https://mastodon.social - user_credentials=feed2toot_usercred.txt - client_credentials=feed2toot_clientcred.txt - ; Default visibility is public, but you can override it: - ; toot_visibility=unlisted - - [cache] - cachefile=cache.db - - [rss] - uri=https://www.journalduhacker.net/rss - toot={title} {link} - - [hashtaglist] - several_words_hashtags_list=hashtags.txt - -* Launch Feed2toot - - $ feed2toot -c /path/to/feed2toot.ini - ### Authors +* MassiveBox * Carl Chenet * Antoine Beaupré * First developed by Todd Eddy diff --git a/docker_entrypoint.sh b/docker_entrypoint.sh new file mode 100755 index 0000000..7360431 --- /dev/null +++ b/docker_entrypoint.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +cd /data + +if [[ ! -f "feed2toot_clientcred.txt" || ! -f "feed2toot_usercred.txt" ]]; then + register_feed2toot_app --instance $INSTANCE --username $USERNAME --password $PASSWORD +fi + +while :; do + feed2toot -c ./feed2toot.ini + sleep 5m +done diff --git a/docs/source/conf.py b/docs/source/conf.py index 1edf696..54b10dc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -31,6 +31,7 @@ import os # ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.autosectionlabel' ] # Add any paths that contain templates here, relative to this directory. @@ -47,16 +48,16 @@ master_doc = 'index' # General information about the project. project = 'feed2toot' -copyright = '2015-2020, Carl Chenet ' +copyright = '2015-2021, Carl Chenet ' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.15' +version = '0.17' # The full version, including alpha/beta/rc tags. -release = '0.15' +release = '0.17' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/source/configure.rst b/docs/source/configure.rst index e18a5eb..a16fd82 100644 --- a/docs/source/configure.rst +++ b/docs/source/configure.rst @@ -1,23 +1,34 @@ Configure Feed2toot =================== +Create credentials for Mastodon +------------------------------- As a prerequisite to use Feed2toot, you need to authorize a Mastodon app for your account. Just use the script register_feed2toot_app to register the feed2toot app for your account.:: $ ./register_feed2toot_app - - This app generates Mastodon app credentials needed by Feed2toot. - feed2toot_clientcred.txt and feed2toot_usercred.txt will be written in the current dir /home/chaica/progra/python/feed2toot. - One connection is initiated to create the app. + + This script generates the Mastodon application credentials for Feed2toot. + feed2toot_clientcred.txt and feed2toot_usercred.txt will be written + in the current directory: /home/me/feed2toot. + WARNING: previous files with the same names will be overwritten. + + A connection is also initiated to create the application. Your password is *not* stored. + + Mastodon instance URL (defaults to https://mastodon.social): https://framapiaf.org + Mastodon login: toto@titi.com + Mastodon password: + + The app feed2toot was added to your Preferences=>Accounts=>Authorized apps page. + The file feed2toot_clientcred.txt and feed2toot_usercred.txt were created in the current directory. - Mastodon instance url (defaults to https://mastodon.social): - Mastodon login:chaica@ohmytux.com - Mastodon password: - The feed2toot app was added to your preferences=>authorized apps page +As described above, two files were created. See the :ref:`Use register_feed2toot_app` section for more options for register_feed2toot_app. -As described above, two files were created. You'll need them in the feed2toot configuration. +Create Feed2toot configuration +------------------------------ +After using register_feed2toot_app, you'll need the credentials in the feed2toot configuration. In order to configure Feed2toot, you need to create a feed2toot.ini file (or any name you prefer, finishing with the extension .ini) with the following parameters:: @@ -88,7 +99,7 @@ For the [rss] section: - {one field of the rss feed}_pattern: takes a string representing a pattern to match for a specified field of each rss entry of the rss feed, like title_pattern or summary_pattern. - {one field of the rss feed}_pattern_case_sensitive: either the pattern matching for the specified field should be case sensitive or not. Default to true if not specified. - no_uri_pattern_no_global_pattern: don't apply global pattern (see above) when no pattern-by-uri is defined in the uri_list. Allows to get all entries of a rss in the uri_list because no pattern is defined so we match them all. Defaults to false, meaning the global patterns will be tried on every rss in the uri_list NOT HAVING specific patterns and so ONLY entries from the specific uri in the uri_list matching the global patterns will be considered. - addtags: add the tags from the rss feed at the end of the toot. Defaults to true. +- addtags: add the tags from the rss feed at the end of the toot. Defaults to true. - ignore_ssl: when the uri or uri_list contains an https url with an invalid certificate (e.g an expired one), feed2toot will be unable to get rss content. This option allows to bypass the ssl security to catch the rss content. Defaults to false. For the [hashtaglist] section: @@ -143,8 +154,8 @@ Match specific patterns of rss feeds in the uri_list files ---------------------------------------------------------- You can use specific pattern matching for uri in the uri_list file to filter some of the rss entries of a rss feed. Lets modify the previous file:: -https://www.journalduhacker.net/rss|title|hacker,psql -https://carlchenet.com/feed|title|gitlab + https://www.journalduhacker.net/rss|title|hacker,psql + https://carlchenet.com/feed|title|gitlab Each line of this file starts with an uri, followed by a pipe (|), followed by the name of the available section to parse (see below), again followed by a pipe (|), followed by patterns, each pattern being separated from the other one by a semi-colon (,). @@ -166,9 +177,3 @@ In you rsslist.txt, just don't give anything else than the needed feed url to ge The last line of the file above only has the url of a rss feed. All entries from this feed will be tooted. -How to display available sections of the rss feed -================================================= -Feed2toot offers the **--rss-sections** command line option to display the available section of the rss feed and exits:: - - $ feed2toot --rss-sections -c feed2toot.ini - The following sections are available in this RSS feed: ['title', 'comments', 'authors', 'link', 'author', 'summary', 'links', 'tags', id', 'author_detail', 'published']. diff --git a/docs/source/install.rst b/docs/source/install.rst index 2e75782..3e885d7 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -25,7 +25,7 @@ Alternatively, Setuptools may be installed to a user-local path:: * Untar the tarball and go to the source directory with the following commands:: - $ tar zxvf feed2toot-0.15.tar.gz + $ tar zxvf feed2toot-0.17.tar.gz $ cd feed2toot * Next, to install Feed2toot on your computer, type the following command with the root user:: diff --git a/docs/source/use.rst b/docs/source/use.rst index 80e4b05..d757345 100644 --- a/docs/source/use.rst +++ b/docs/source/use.rst @@ -5,7 +5,7 @@ After the configuration of Feed2toot, just launch the following command:: $ feed2toot -c /path/to/feed2toot.ini Run Feed2toot on a regular basis -================================= +--------------------------------- Feed2toot should be launched on a regular basis in order to efficiently send your new RSS entries to Mastodon. It is quite easy to achieve by adding a line to your user crontab, as described below:: @hourly feed2toot -c /path/to/feed2toot.ini @@ -15,19 +15,19 @@ will execute feed2toot every hour. Or without the syntactic sugar in the global 0 * * * * johndoe feed2toot -c /path/to/feed2toot.ini Test option -=========== +----------- In order to know what's going to be sent to Mastodon without actually doing it, use the **--dry-run** option:: $ feed2toot --dry-run -c /path/to/feed2toot.ini Debug option -============ +------------ In order to increase the verbosity of what's Feed2toot is doing, use the **--debug** option followed by the level of verbosity see [the the available different levels](https://docs.python.org/3/library/logging.html):: $ feed2toot --debug -c /path/to/feed2toot.ini -Populate the cache file without posting tweets -============================================== +Populate the cache file without posting toots +--------------------------------------------- Starting from 0.8, Feed2toot offers the **--populate-cache** command line option to populate the cache file without posting to Mastodon:: $ feed2toot --populate-cache -c feed2toot.ini @@ -43,22 +43,55 @@ Starting from 0.8, Feed2toot offers the **--populate-cache** command line option populating RSS entry https://www.journalduhacker.net/s/lqswmz How to display available sections of the rss feed -================================================= +------------------------------------------------- Starting from 0.8, Feed2toot offers the **--rss-sections** command line option to display the available section of the rss feed and exits:: $ feed2toot --rss-sections -c feed2toot.ini The following sections are available in this RSS feed: ['title', 'comments', 'authors', 'link', 'author', 'summary', 'links', 'tags', id', 'author_detail', 'published']. Using syslog -============ +------------ Feed2toot is able to send its log to syslog. You can use it with the following command:: $ feed2toot --syslog=WARN -c /path/to/feed2toot.ini Limit number of rss entries published at each execution -======================================================= +------------------------------------------------------- If you want to limit the number of rss entries published at each execution, you can use the --limit CLI option. $ feed2toot --limit 5 -c /path/to/feed2toot.ini The number of posts to Mastodon will be at 5 posts top with this CLI option. + +Use register_feed2toot_app +========================== +You need a Mastodon app associated to a user on the Mastodon instance. The script register_feed2toot_app will create an app for Feed2toot and upload it on the specified Mastodon instance. + +Primary usage :: + + $ register_feed2toot_app + +Possible CLI options: + +- use the **--client-credentials-file** option to change the filename in which the client credentials are stored (defaults to feed2toot_clientcred.txt) +- use the **--user-credentials-file** option to change the filename in which the user credentials are stored (defaults to feed2toot_usercred.txt) +- use the **--name** to change the Mastodon app name (defaults to feed2toot) + +Example with full options and full output:: + + $ ./register_feed2toot_app --user-credentials-file f2tusercreds.txt --client-credentials-file f2tclientcreds.txt --name f2t + + This script generates the Mastodon application credentials for Feed2toot. + f2tclientcreds.txt and f2tusercreds.txt will be written + in the current directory: /home/me/feed2toot/scripts. + WARNING: previous files with the same names will be overwritten. + + A connection is also initiated to create the application. + Your password is *not* stored. + + Mastodon instance URL (defaults to https://mastodon.social): https://framapiaf.org + Mastodon login: toto@titi.com + Mastodon password: + + The app f2t was added to your preferences=>authorized apps page. + The file f2tclientcreds.txt and f2tusercreds.txt were created in the current directory. diff --git a/feed2toot.py b/feed2toot.py index 416e53b..a53bf2a 100755 --- a/feed2toot.py +++ b/feed2toot.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/__init__.py b/feed2toot/__init__.py index dad5d70..979c3de 100644 --- a/feed2toot/__init__.py +++ b/feed2toot/__init__.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/addtags.py b/feed2toot/addtags.py index 2cd8668..cca0954 100644 --- a/feed2toot/addtags.py +++ b/feed2toot/addtags.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/cliparse.py b/feed2toot/cliparse.py index cdeb811..e8d8739 100644 --- a/feed2toot/cliparse.py +++ b/feed2toot/cliparse.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or @@ -24,7 +24,7 @@ import os import os.path import sys -__version__ = '0.15' +__version__ = '0.17' class CliParse: '''CliParse class''' diff --git a/feed2toot/confparse.py b/feed2toot/confparse.py index baa67c3..54010a2 100644 --- a/feed2toot/confparse.py +++ b/feed2toot/confparse.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/__init__.py b/feed2toot/confparsers/__init__.py index dad5d70..979c3de 100644 --- a/feed2toot/confparsers/__init__.py +++ b/feed2toot/confparsers/__init__.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/cache.py b/feed2toot/confparsers/cache.py index 2ca2515..79c013d 100644 --- a/feed2toot/confparsers/cache.py +++ b/feed2toot/confparsers/cache.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/feedparser.py b/feed2toot/confparsers/feedparser.py index c7467ba..cf72889 100644 --- a/feed2toot/confparsers/feedparser.py +++ b/feed2toot/confparsers/feedparser.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/hashtaglist.py b/feed2toot/confparsers/hashtaglist.py index d965cfa..ffdf710 100644 --- a/feed2toot/confparsers/hashtaglist.py +++ b/feed2toot/confparsers/hashtaglist.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/hashtags/__init__.py b/feed2toot/confparsers/hashtags/__init__.py index dad5d70..979c3de 100644 --- a/feed2toot/confparsers/hashtags/__init__.py +++ b/feed2toot/confparsers/hashtags/__init__.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/hashtags/nohashtags.py b/feed2toot/confparsers/hashtags/nohashtags.py index 42a985b..0cab8b6 100644 --- a/feed2toot/confparsers/hashtags/nohashtags.py +++ b/feed2toot/confparsers/hashtags/nohashtags.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/lock.py b/feed2toot/confparsers/lock.py index c3ed485..45e7718 100644 --- a/feed2toot/confparsers/lock.py +++ b/feed2toot/confparsers/lock.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/media.py b/feed2toot/confparsers/media.py index 47e2708..2cd4f1b 100644 --- a/feed2toot/confparsers/media.py +++ b/feed2toot/confparsers/media.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/plugins.py b/feed2toot/confparsers/plugins.py index 05f3b80..0911a6b 100644 --- a/feed2toot/confparsers/plugins.py +++ b/feed2toot/confparsers/plugins.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/rss/__init__.py b/feed2toot/confparsers/rss/__init__.py index dad5d70..979c3de 100644 --- a/feed2toot/confparsers/rss/__init__.py +++ b/feed2toot/confparsers/rss/__init__.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/rss/addtags.py b/feed2toot/confparsers/rss/addtags.py index 4fc611d..6808254 100644 --- a/feed2toot/confparsers/rss/addtags.py +++ b/feed2toot/confparsers/rss/addtags.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/rss/ignoressl.py b/feed2toot/confparsers/rss/ignoressl.py index da67dcb..f1f0340 100644 --- a/feed2toot/confparsers/rss/ignoressl.py +++ b/feed2toot/confparsers/rss/ignoressl.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/rss/pattern.py b/feed2toot/confparsers/rss/pattern.py index cbe635f..e6b858d 100644 --- a/feed2toot/confparsers/rss/pattern.py +++ b/feed2toot/confparsers/rss/pattern.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/rss/toot.py b/feed2toot/confparsers/rss/toot.py index 5f8b96c..58c8f56 100644 --- a/feed2toot/confparsers/rss/toot.py +++ b/feed2toot/confparsers/rss/toot.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/rss/tootmaxlen.py b/feed2toot/confparsers/rss/tootmaxlen.py index 88af10c..eb2a448 100644 --- a/feed2toot/confparsers/rss/tootmaxlen.py +++ b/feed2toot/confparsers/rss/tootmaxlen.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/rss/uri.py b/feed2toot/confparsers/rss/uri.py index 7e0a1b2..e7f88b2 100644 --- a/feed2toot/confparsers/rss/uri.py +++ b/feed2toot/confparsers/rss/uri.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/confparsers/rss/urilist.py b/feed2toot/confparsers/rss/urilist.py index 9027498..11265a2 100644 --- a/feed2toot/confparsers/rss/urilist.py +++ b/feed2toot/confparsers/rss/urilist.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/feedcache.py b/feed2toot/feedcache.py index 8b85edd..9bfad65 100644 --- a/feed2toot/feedcache.py +++ b/feed2toot/feedcache.py @@ -1,5 +1,5 @@ # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/filterentry.py b/feed2toot/filterentry.py index 44608d5..37a7a76 100644 --- a/feed2toot/filterentry.py +++ b/feed2toot/filterentry.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/hashtags.py b/feed2toot/hashtags.py index 893ba8c..6354614 100644 --- a/feed2toot/hashtags.py +++ b/feed2toot/hashtags.py @@ -1,5 +1,5 @@ # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/lock.py b/feed2toot/lock.py index e58ff3e..e03c56c 100644 --- a/feed2toot/lock.py +++ b/feed2toot/lock.py @@ -1,5 +1,5 @@ # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/main.py b/feed2toot/main.py index da76c73..1c70e03 100644 --- a/feed2toot/main.py +++ b/feed2toot/main.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/message.py b/feed2toot/message.py index a71eb20..ef431d6 100644 --- a/feed2toot/message.py +++ b/feed2toot/message.py @@ -1,5 +1,5 @@ # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/removeduplicates.py b/feed2toot/removeduplicates.py index f7f76c2..8141d4f 100644 --- a/feed2toot/removeduplicates.py +++ b/feed2toot/removeduplicates.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/rss.py b/feed2toot/rss.py index 27e63f4..da271d9 100644 --- a/feed2toot/rss.py +++ b/feed2toot/rss.py @@ -1,5 +1,5 @@ # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/sortentries.py b/feed2toot/sortentries.py index d88920b..f5ac5ef 100644 --- a/feed2toot/sortentries.py +++ b/feed2toot/sortentries.py @@ -1,5 +1,5 @@ # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/feed2toot/tootpost.py b/feed2toot/tootpost.py index 43eae3f..9cf7d0d 100644 --- a/feed2toot/tootpost.py +++ b/feed2toot/tootpost.py @@ -1,5 +1,5 @@ # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/scripts/__init__.py b/scripts/__init__.py new file mode 100644 index 0000000..979c3de --- /dev/null +++ b/scripts/__init__.py @@ -0,0 +1,15 @@ +#!/usr/bin/env python3 +# vim:ts=4:sw=4:ft=python:fileencoding=utf-8 +# Copyright © 2015-2021 Carl Chenet +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see diff --git a/scripts/feed2toot b/scripts/feed2toot index 0391cdb..09cf4dd 100755 --- a/scripts/feed2toot +++ b/scripts/feed2toot @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or diff --git a/scripts/register_feed2toot_app b/scripts/register_feed2toot_app index 6a5446a..7453ecc 100755 --- a/scripts/register_feed2toot_app +++ b/scripts/register_feed2toot_app @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # vim:ts=4:sw=4:ft=python:fileencoding=utf-8 -# Copyright © 2015-2020 Carl Chenet +# Copyright © 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or @@ -14,16 +14,42 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see +from argparse import ArgumentParser from getpass import getpass from os import getcwd +from os import linesep +from os import sep from mastodon import Mastodon from mastodon.Mastodon import MastodonIllegalArgumentError import sys -print('\nThis script generates the Mastodon application credentials for Feed2toot.\nfeed2toot_clientcred.txt and feed2toot_usercred.txt will be written\nin the current directory: {cwd}.\nA connection is initiated to create the application.\nYour password is *not* stored.\n'.format(cwd=getcwd())) +__version__ = '0.2' + +epilog = 'For more information: https://feed2toot.readthedocs.io' +description = 'Create a Mastodon app for Feed2toot' +parser = ArgumentParser(prog='register_feed2toot_app', + description=description, + epilog=epilog) +parser.add_argument('--version', action='version', version=__version__) +parser.add_argument('--client-credentials-file', dest='clientcredfile', help='the name of the client credentials for the Mastodon app', default='feed2toot_clientcred.txt') +parser.add_argument('--user-credentials-file', dest='usercredfile', help='the name of the user credentials for the Mastodon app', default='feed2toot_usercred.txt') +parser.add_argument('--name', help='the name of the Mastodon app', default='feed2toot') +parser.add_argument('--instance', help='the URL of the Mastodon instance') +parser.add_argument('--username', help='the username of your Mastodon account') +parser.add_argument('--password', help='the password of your Mastodon account') +opts = parser.parse_args() + +clientcredfile=opts.clientcredfile +usercredfile=opts.usercredfile + +headline = '{linesep}This script generates the Mastodon application credentials for Feed2toot.{linesep}{clientcredfile} and {usercredfile} will be written{linesep}in the current directory: {cwd}.{linesep}WARNING: previous files with the same names will be overwritten.{linesep}{linesep}A connection is also initiated to create the application.{linesep}Your password is *not* stored.{linesep}'.format(linesep=linesep, clientcredfile=clientcredfile, usercredfile=usercredfile, cwd=getcwd()) +print(headline) + # get the instance -instance = input('Mastodon instance URL (defaults to https://mastodon.social): ') +instance = opts.instance +if not instance: + instance = input('Mastodon instance URL (defaults to https://mastodon.social): ') if not instance: instance = 'https://mastodon.social' elif not instance.startswith('http'): @@ -31,34 +57,45 @@ elif not instance.startswith('http'): # get the username userok = False +quit_on_error = True while not userok: - user = input('Mastodon login: ') + user = opts.username + if not user: + user = input('Mastodon login: ') + quit_on_error = False if not user: print('Your Mastodon username can not be empty.') - userok = False elif '@' not in user or '.' not in user: print('Your Mastodon username should be an email.') - userok = False else: userok = True + if not userok and quit_on_error: + exit() # get the password -password = getpass(prompt='Mastodon password: ') +password = opts.password +if not password: + password = getpass(prompt='Mastodon password: ') Mastodon.create_app( - 'feed2toot', + opts.name, api_base_url=instance, - to_file = '{cwd}/feed2toot_clientcred.txt'.format(cwd=getcwd()) + to_file = '{cwd}{sep}{clientcredfile}'.format(cwd=getcwd(), sep=sep, clientcredfile=clientcredfile) ) -mastodon = Mastodon(client_id = '{cwd}/feed2toot_clientcred.txt'.format(cwd=getcwd()), +mastodon = Mastodon(client_id = '{cwd}{sep}{clientcredfile}'.format(cwd=getcwd(), sep=sep, clientcredfile=clientcredfile), api_base_url=instance) try: mastodon.log_in( user, password, - to_file = '{cwd}/feed2toot_usercred.txt'.format(cwd=getcwd()) + to_file = '{cwd}{sep}{usercredfile}'.format(cwd=getcwd(), sep=sep, usercredfile=usercredfile) ) except MastodonIllegalArgumentError as err: print(err) - sys.exit('\nI guess you entered a bad login or password.\n') -print('feed2toot was added to your preferences=>authorized apps page.') + sys.exit('{linesep}I guess you entered a bad login or password.{linesep}'.format(linesep=linesep)) + +summary = '{linesep}The app {appname} was added to your Preferences=>Accounts=>Authorized apps page.{linesep}The file {clientcredfile} and {usercredfile} were created in the current directory.{linesep}'.format(appname=opts.name, + linesep=linesep, + clientcredfile=clientcredfile, + usercredfile=usercredfile) +print(summary) sys.exit(0) diff --git a/setup.py b/setup.py index c1fa29b..6ce1662 100755 --- a/setup.py +++ b/setup.py @@ -1,4 +1,4 @@ -# Copyright 2015-2020 Carl Chenet +# Copyright 2015-2021 Carl Chenet # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or @@ -31,7 +31,7 @@ CLASSIFIERS = [ setup( name='feed2toot', - version='0.15', + version='0.17', license='GNU GPL v3', description='Parse rss feeds and send new posts to Mastodon', long_description='Parse rss feeds and send new posts to the Mastodon social network',