spread-revolutionary-date - Spread date and time from Revolutionary (Republican) Calendar
version 0.07
spread-revolutionary-date is a Free Software that spreads the current date, expressed in French Revolutionary calendar, to various social networks: Twitter, Mastodon, and the Freenode Internet Relay Chat network. And you can easily extend these defaults targets with any desired one, see "EXTENDING TO NEW TARGETS".
spread-revolutionary-date
The French Revolutionary calendar, also called Republican calendar, was introduced during the French Revolution, and used from late 1793 to 1805, and also during the Paris Commune in 1871. This was an attempt to get rid of religious and royalist references found in Gregorian calendar when naming measures of Time. Months were given new names based on nature, each day of the year, instead of being named after an associated saint, had a unique name associated with the rural economy: agricultural tools, common animals, grains, pastures, trees, roots, flowers, fruits, plants, and minerals. But this was also an attempt to give more rational in measuring Time, basing measures on decimal system. Instead of weeks, each month was divided into exactly 3 décades, that is ten days; days were divided into ten hours; hours into 100 minutes; and minutes into 100 seconds.
You must have a registering account on each of the targets you want to spread the revolutionary date. And you must get credentials for spread-revolutionary-date to post on Twitter and Mastodon. Finally, you have to configure spread-revolutionary-date to use these credentials, see "CONFIGURATION" and "COMMAND LINE PARAMETERS" below.
The revolutionary date and time is computed thanks to the DateTime::Calendar::FrenchRevolutionary Perl module, by Jean Forget.
# Just execute the script in your shell # to spread current date to configured accounts on Twitter, Mastodon and Freenode: $ spread-revolutionary-date # Or, since this script do nothing but calling the L<App::SpreadRevolutionaryDate> Perl module, # use this one-liner: $ perl -MApp::SpreadRevolutionaryDate -e 'App::SpreadRevolutionaryDate->new->spread;' # Test spreading to Mastodon only: $ spread-revolutionary-date --mastodon --test # Test spreading to Twitter only in English: $ spread-revolutionary-date --twitter --test --locale=en # Spread to Twitter and Freenode explicit channels $ spread-revolutionary-date --twitter --freenode \ --freenode-channels='#revolution' --freenode-channels='#acab'
Once again: you have to configure spread-revolutionary-date with credentials for registered account on each of the desired targets, so it can spread the revolutionary date on behalf of these accounts.
Configuration options may also be specified as command line parameters, see "COMMAND LINE PARAMETERS" below, which take precedence on options of the configuration file.
The configuration file should lie on ~/.config/spread-revolutionary-date/spread-revolutionary-date.conf or ~/.spread-revolutionary-date.conf. In case a file is found on both paths, the second one is ignored. The configuration file should use the popular INI file format. A sample configuration file can be found in this distribution at etc/sample-spread-revolutionary-date.conf.
~/.config/spread-revolutionary-date/spread-revolutionary-date.conf
~/.spread-revolutionary-date.conf
etc/sample-spread-revolutionary-date.conf
These options should appear outside of any section of the configuration file.
This option can be specified multiple time. It explicitly defines targets where the revolutionary date should be spread to. Any value set for this option should be a valid target: any of the three default targets (twitter, mastodon, or freenode) or some new target if you have extended this application (see "EXTENDING TO NEW TARGETS"). If this option is not defined, the revolutionary date is spread on all of three default targets: twitter, mastodon, and freenode.
twitter
mastodon
freenode
Spread with chosen language. As of DateTime::Calendar::FrenchRevolutionary 0.14, locale is limited to 'en' or 'fr', defaults to 'fr'.
Do no not actually spread the revolutionary date, just print it on standard output for Twitter and Mastodon, and send it on configured test channels for Freenode (see "test_channels" below).
Instead of spreading the current date and time, pretend that decimal time is 1:31:20 (which corresponds to 03:08:56 Paris time, in sexagesimal scale used by common Anglo-Babylonian Time).
This option is deprecated since version 0.07 of this distribution and may be removed in future release. Please use "targets" option below. Spread on Twitter explicitly. If none of the twitter, mastodon, freenode option is set, the revolutionary date is spread on all of these three targets.
This option is deprecated since version 0.07 of this distribution and may be removed in future release. Please use "targets" option below. Spread on Mastodon explicitly. If none of the twitter, mastodon, freenode option is set, the revolutionary date is spread on all of these three targets.
This option is deprecated since version 0.07 of this distribution and may be removed in future release. Please use "targets" option below. Spread on Freenode explicitly. If none of the twitter, mastodon, freenode option is set, the revolutionary date is spread on all of these three targets.
These options are credentials for spread-revolutionary-date to spread on a Twitter account. You have to get them from your Twitter API account with write access level.
write
Your Twitter Consumer API key for this application.
Your Twitter Consumer API secret key for this application.
Your Twitter Access token for this application.
Your Twitter Access token secret for this application.
These options are credentials for spread-revolutionary-date to spread on a Mastodon account. You have to get them from your Mastodon instance API account with write scope. Note that Mastodon is a decentralized network with multiple instances, the previous link is for mstdn.fr instance, please replace url with your preferred instance.
The domain name of your instance, eg: mastodon.social, mstdn.fr, etc.
mastodon.social
mstdn.fr
Your Mastodon Client key for this application.
Your Mastodon Client secret for this application.
Your Mastodon Access token for this application.
The first two options are credentials for spread-revolutionary-date to spread on a Freenode account. See https://freenode.net/kb/answer/registration to find out how to register an account on Freenode.
Your Freenode nickname.
Your Freenode password.
This option can be specified multiple time. spread-revolutionary-date will spread on every channel specified with this option. This option should be specified at least one time if "test" option is not set. It is ignored if "test" option is set.
This option can be specified multiple time. spread-revolutionary-date will spread on every channel specified with this option. This option should be specified at least one time if "test" option is set. It is ignored if "test" option is not set.
Any command line parameter takes precedence on the corresponding option specified on the confiuration file, see ""CONFIGURATION" below.
Same as "targets" configuration option below.
Same as "locale" configuration option below.
Same as "test" configuration option below.
Same as "acab" configuration option below.
Same as "twitter" configuration option below.
Same as "mastodon" configuration option below.
Same as "freenode" configuration option below.
These parameters specify credentials for spread-revolutionary-date to spread on a Twitter account. You have to get them from your Twitter API account with write access level.
Same as "consumer_key" configuration option below.
Same as "consumer_secret" configuration option below.
Same as "access_token" configuration option below.
Same as "access_token_secret" configuration option below.
These parameters specify credentials for spread-revolutionary-date to spread on a Mastodon account. You have to get them from your Mastodon instance API account with write scope. Note that Mastodon is a decentralized network with multiple instances, the previous link is for mstdn.fr instance, please replace url with your preferred instance.
Same as "instance" configuration option below.
Same as "client_id" configuration option below.
Same as "client_secret" configuration option below.
The first two parameters are credentials for spread-revolutionary-date to spread on a Freenode account. See https://freenode.net/kb/answer/registration to find out how to register an account on Freenode.
Same as "nickname" configuration option below.
Same as "password" configuration option below.
Same as "channels" configuration option below.
Same as "test_channels" configuration option below.
Version 0.07 of this distribution is a complete redesign of the API, taking advantage of Moose, the postmodern object system for Perl 5, allowing to easily extend spread-revolutionary-date to other targets than the default ones (Twitter, Mastondon and Freenode.
Twitter
Mastondon
Freenode
To add a new target, you should write a new class in the App::SpreadRevolutionaryDate::Target:: namespace (that is: the class should be App::SpreadRevolutionaryDate::Target::Mytarget for a new Mytarget target), that consumes the App::SpreadRevolutionaryDate::Target role. See "DESCRIPTION" in App::SpreadRevolutionaryDate::Target for a comprehensive description of this role.
App::SpreadRevolutionaryDate::Target::
App::SpreadRevolutionaryDate::Target::Mytarget
Mytarget
Such a target class is actually just a wrapper. Usually a target has to use an existing specific module (which can be a Moose class or not) to perform the actual work of posting a message according the specific target protocol, after having complied with any potential required authentication. Such authentication and posting should be carried on by the constructor or the required spread method of the target class.
Moose
spread
To perform authentication and to post a message, there is a strong likelihood that the new target requires specific parameters (for eg. tokens, keys, account name, password, channels, etc.). These parameters should be defined as required attributes of the target class. Values for such attributes should be set in the configuration file, inside a section named after the target ([mytarget]), or as command line parameters prefixed with the name of the target followed by a dash (--mytarget-myparam).
[mytarget]
--mytarget-myparam
Should you extend spread-revolutionary-date to a new target, we advise you to have a look on how of default targets are implemented: App::SpreadRevolutionaryDate::Target::Twitter with Net::Twitter::Lite::WithAPIv1_1 worker, App::SpreadRevolutionaryDate::Target::Mastodon with Mastodon::Client worker. Both are using OAuth2 protocol to perform authentication. The third default target, App::SpreadRevolutionaryDate::Target::Freenode, uses a chatbot: App::SpreadRevolutionaryDate::Target::Freenode::Bot subclassing Bot::BasicBot. You can also see a very simple example with a test file provided in this distribution at t/new_target.t, which just prints out the revolutionary date on the standard input using core module IO::Handle.
worker
App::SpreadRevolutionaryDate::Target::Freenode
t/new_target.t
Gérald Sédrati-Dinet <gibus@cpan.org>
This software is Copyright (c) 2019 by Gérald Sédrati-Dinet.
This is free software, licensed under:
The GNU General Public License, Version 3, June 2007
To install App::SpreadRevolutionaryDate, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::SpreadRevolutionaryDate
CPAN shell
perl -MCPAN -e shell install App::SpreadRevolutionaryDate
For more information on module installation, please visit the detailed CPAN module installation guide.