From 4048bd9abd44a2a8c28eb2ace3cc80a4c28b7b9b Mon Sep 17 00:00:00 2001 From: Carl Chenet Date: Thu, 22 Aug 2019 00:41:51 +0200 Subject: [PATCH] bump version, write doc, write changelog --- CHANGELOG | 20 +++++++++++++------- README.md | 2 +- docs/source/conf.py | 4 ++-- docs/source/configure.rst | 9 +++++++++ docs/source/install.rst | 2 +- feed2toot/cliparse.py | 2 +- setup.py | 2 +- 7 files changed, 28 insertions(+), 13 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index a568522..44b7a01 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,7 +1,13 @@ +## [0.11] - 2019-08-24 +### Added +- command line options --lock-file to define a lock file +- command line options --lock-timeout to remove this lock file automatically +- lock section in configuration with lock_file andd lock_time parameters + ## [0.10] - 2018-09-22 ### Added -- new syntax for the toot parameter of [rss] section. Use {summary:.100} to cut the rss field summary after the first 100 characters. Contributed by Matthias Henze. -- add the addtags parameter of the [rss] section. Contributed by Matthias Henze. +- new syntax for the toot parameter of [rss] section. Use {summary:.100} to cut the rss field summary after the first 100 characters. Contributed by Matthias Henze +- add the addtags parameter of the [rss] section. Contributed by Matthias Henze ## [0.9] - 2018-06-07 ### Added @@ -17,14 +23,14 @@ ## [0.6] - 2017-08-02 ### Added -- define a name for a feed, accessible with {feedname}. Contributed by Alexis Metaireau. -- switch the toot visibility. Contributed by The Dod. -- new accept_bozo_exceptions option to allow malformed rss feeds. Contributed by Alexis Metaireau. +- define a name for a feed, accessible with {feedname}, contributed by Alexis Metaireau +- switch the toot visibility. Contributed by The Dod +- new accept_bozo_exceptions option to allow malformed rss feeds, contributed by Alexis Metaireau ### Changed - configuration parser was split into much smaller chunks -- remove useless imports and coding style. Contributed by Alexis Metaireau. -- rephrasing and reformatting of the script register_feed2toot_app. Contributed by Bastien Guerry. +- remove useless imports and coding style, contributed by Alexis Metaireau +- rephrasing and reformatting of the script register_feed2toot_app, contributed by Bastien Guerry ## [0.5] - 2017-05-05 ### Added diff --git a/README.md b/README.md index d87c7af..46e6e3b 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Alternatively you can donate cryptocurrencies: [Installation Guide](http://feed2toot.readthedocs.org/en/latest/install.html)* - # tar zxvf feed2toot-0.10.tar.gz + # tar zxvf feed2toot-0.11.tar.gz # cd feed2toot # python3 setup.py install # # or diff --git a/docs/source/conf.py b/docs/source/conf.py index 4c756fa..a6641c7 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,9 +54,9 @@ copyright = '2015-2019, Carl Chenet ' # built documents. # # The short X.Y version. -version = '0.10' +version = '0.11' # The full version, including alpha/beta/rc tags. -release = '0.10' +release = '0.11' # 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 0203427..25677da 100644 --- a/docs/source/configure.rst +++ b/docs/source/configure.rst @@ -33,6 +33,10 @@ In order to configure Feed2toot, you need to create a feed2toot.ini file (or any cachefile=/var/lib/feed2toot/feed2toot.db cache_limit=10000 + [lock] + lock_file=/var/lock/feed2toot.lock + lock_timeout=3600 + [rss] uri=https://www.journalduhacker.net/rss uri_list=/etc/feed2toot//rsslist.txt @@ -67,6 +71,11 @@ For the [cache] section: - cachefile: the path to the cache file storing ids of already tooted links. Absolute path is mandatory. This file should always use the .db extension. - cache_limit: length of the cache queue. defaults to 100. +For the [lock] section (starting from version 0.11): + +- lock_file: lock to stop any other feed2toot instance to run at the same time. Default is ~/.config/feed2toot.lock +- lock_timeout: automatically remove the lock if the datetime in the lock file is greater than n seconds. Default is 3600 seconds. + For the [rss] section: - uri: the url of the rss feed to parse diff --git a/docs/source/install.rst b/docs/source/install.rst index 2b0ca17..ef0a3f4 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.10.tar.gz + $ tar zxvf feed2toot-0.11.tar.gz $ cd feed2toot * Next, to install Feed2toot on your computer, type the following command with the root user:: diff --git a/feed2toot/cliparse.py b/feed2toot/cliparse.py index 9862c4e..7575a48 100644 --- a/feed2toot/cliparse.py +++ b/feed2toot/cliparse.py @@ -24,7 +24,7 @@ import os import os.path import sys -__version__ = '0.10' +__version__ = '0.11' class CliParse: '''CliParse class''' diff --git a/setup.py b/setup.py index e4f5b5d..69d9870 100755 --- a/setup.py +++ b/setup.py @@ -31,7 +31,7 @@ CLASSIFIERS = [ setup( name='feed2toot', - version='0.10', + version='0.11', 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',