massivebox/feed2toot-docker
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

bump version, write doc, write changelog

Browse source
This commit is contained in:
Carl Chenet 2019-08-22 00:41:51 +02:00
parent 64f33ecfac
commit 4048bd9abd
7 changed files with 28 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CHANGELOG
View file

@ -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 ## [0.10] - 2018-09-22
### Added ### 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. - 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. - add the addtags parameter of the [rss] section. Contributed by Matthias Henze
## [0.9] - 2018-06-07 ## [0.9] - 2018-06-07
### Added ### Added
@ -17,14 +23,14 @@
## [0.6] - 2017-08-02 ## [0.6] - 2017-08-02
### Added ### Added
- define a name for a feed, accessible with {feedname}. 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. - switch the toot visibility. Contributed by The Dod
- new accept_bozo_exceptions option to allow malformed rss feeds. Contributed by Alexis Metaireau. - new accept_bozo_exceptions option to allow malformed rss feeds, contributed by Alexis Metaireau
### Changed ### Changed
- configuration parser was split into much smaller chunks - configuration parser was split into much smaller chunks
- remove useless imports and coding style. Contributed by Alexis Metaireau. - remove useless imports and coding style, contributed by Alexis Metaireau
- rephrasing and reformatting of the script register_feed2toot_app. Contributed by Bastien Guerry. - rephrasing and reformatting of the script register_feed2toot_app, contributed by Bastien Guerry
## [0.5] - 2017-05-05 ## [0.5] - 2017-05-05
### Added ### Added

2
README.md
View file

@ -20,7 +20,7 @@ Alternatively you can donate cryptocurrencies:
[Installation Guide](http://feed2toot.readthedocs.org/en/latest/install.html)* [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 # cd feed2toot
# python3 setup.py install # python3 setup.py install
# # or # # or

4
docs/source/conf.py
View file

@ -54,9 +54,9 @@ copyright = '2015-2019, Carl Chenet <chaica@ohmytux.com>'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.10' version = '0.11'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.10' release = '0.11'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.

9
docs/source/configure.rst
View file

@ -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 cachefile=/var/lib/feed2toot/feed2toot.db
cache_limit=10000 cache_limit=10000
[lock]
lock_file=/var/lock/feed2toot.lock
lock_timeout=3600
[rss] [rss]
uri=https://www.journalduhacker.net/rss uri=https://www.journalduhacker.net/rss
uri_list=/etc/feed2toot//rsslist.txt 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. - 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. - 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: For the [rss] section:
- uri: the url of the rss feed to parse - uri: the url of the rss feed to parse

2
docs/source/install.rst
View file

@ -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:: * 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 $ cd feed2toot
* Next, to install Feed2toot on your computer, type the following command with the root user:: * Next, to install Feed2toot on your computer, type the following command with the root user::

2
feed2toot/cliparse.py
View file

@ -24,7 +24,7 @@ import os
import os.path import os.path
import sys import sys
__version__ = '0.10' __version__ = '0.11'
class CliParse: class CliParse:
'''CliParse class''' '''CliParse class'''

2
setup.py
View file

@ -31,7 +31,7 @@ CLASSIFIERS = [
setup( setup(
name='feed2toot', name='feed2toot',
version='0.10', version='0.11',
license='GNU GPL v3', license='GNU GPL v3',
description='Parse rss feeds and send new posts to Mastodon', description='Parse rss feeds and send new posts to Mastodon',
long_description='Parse rss feeds and send new posts to the Mastodon social network', long_description='Parse rss feeds and send new posts to the Mastodon social network',