Difference between revisions of "Begiak"

From Apertium
Jump to navigation Jump to search
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{TOCD}}
 
{{TOCD}}
'''begiak''' is the IRC bot in the #apertium [[IRC]] channel. It serves several purposes, including to showcase some applications of the apertium translation [[API]] and to facilitate communication when users are offline.
+
'''begiak''' is the IRC bot in the #apertium [[IRC]] channel. It serves several purposes, including to showcase some applications of the apertium translation [[API]], getting information about languages and other topics, and providing various forms of reminders, as well as a couple features that are just for fun.
   
 
== Background ==
 
== Background ==
Line 10: Line 10:
 
Begiak recognises the following commands.
 
Begiak recognises the following commands.
   
* .awikstats update <lang> update the wikipage apertium-LANG/stats (note: will dump a bunch of info in private chat)
+
* <code>.awikstats update <lang></code> — update the wikipage apertium-LANG/stats (note: will dump a bunch of info in private chat)
* .follow <nick> <lg1-lg2> [follower] — Follow someone and translate as they speak. (Translations are sent as notices to the follower (follower feature is admin only!))
+
* <code>.follow <nick> <lg1-lg2> [follower]</code> — Follow someone and translate as they speak. (Translations are sent as notices to the follower (follower feature is admin only!))
* .following — List people currently being followed.
+
* <code>.following</code> — List people currently being followed.
* .iso639 <lg> — look up [http://en.wikipedia.org/wiki/ISO_639 ISO 639]-1, -2 and -3 language codes either by code or by language name. Codes sourced from Ethnologue.com (639-3) and Wikipedia (-1 and -2)
+
* <code>.iso639 <lg></code> — look up [http://en.wikipedia.org/wiki/ISO_639 ISO 639]-1, -2 and -3 language codes either by code or by language name. Codes sourced from Ethnologue.com (639-3) and Wikipedia (-1 and -2)
* .isodb status — see if the database updater (.isodb update) is running
+
* <code>.isodb status</code> — see if the database updater (.isodb update) is running
* .issue <title>— create a new GitHub issue.
+
* <code>.issue <title></code> — create a new GitHub issue.
* .listpairs <lg> — List language pairs available for apertium translation
+
* <code>.listpairs <lg></code> — List language pairs available for apertium translation
* .listlangs — List languages available for apertium translation
+
* <code>.listlangs</code> — List languages available for apertium translation
* .t <lg1-lg2> [ | lg2-lg3 ...] <text>'' — Apertium translate
+
* <code>.t <lg1-lg2> [ | lg2-lg3 ...] <text>''</code> — Apertium translate
* .unfollow <nick> — Stop following a user.
+
* <code>.unfollow <nick></code> — Stop following a user.
  +
* <code>.8ball</code> — magic 8 ball
<!--* begiak: esan! — Poll for svn updates ("esan!" means "say!" in Basque)
 
  +
* <code>.beats</code> — Shows the internet time in Swatch beats
* begiak: recent — Get most recent svn/git updates ([[Begiak's git plugin]] describes the git part)
 
 
* <code>.botsnack</code> — Give begiak a snack for being good
* begiak: info <repo> <rev> — Get information on a given revision of a given SVN or git repository ([http://wiki.apertium.org/wiki/Begiak%27s_git_plugin Begiak's git plugin] describes the git part)-->
 
* .8ballmagic 8 ball
+
* <code>.c</code>Calculator using SymPy.
* .beatsShows the internet time in Swatch beats
+
* <code>.chill</code>Measure the current channel chillness level.
  +
* <code>.choose <choice1> <choice2></code> — begiak will choose one of the two options (randomly).
* .botsnack — Give begiak a snack for being good
 
 
* <code>.ety</code> — Look up the etymology of a word
* .c — Calculator using SymPy.
 
  +
* <code>.fcc <callsign></code> — Look up a callsign issued by the FCC
* .chill — Measure the current channel chillness level.
 
* .choose <choice1> <choice2> — begiak will choose one of the two options (randomly).
+
* <code>.fight <nick></code> — have begiak fight someone for you.
  +
* <code>.hug <nick></code> — have begiak hug someone for you.
* .ety — Look up the etymology of a word
 
* .fcc <callsign> — Look up a callsign issued by the FCC
+
* <code>.in <time></code> — Set a reminder
* .fight <nick> — have begiak fight someone for you.
+
* <code>.linx <url></code> — Upload ''url'' to linx.li
* .hug <nick> — have begiak hug someone for you.
+
* <code>.npl</code> — Shows the time from NPL's SNTP server
* .in <time> — Set a reminder
+
* <code>.nsfw <link></code> — for when a link isn't safe for work
 
* <code>.pesters
* .linx <url> — Upload ''url'' to linx.li
 
 
** begiak: pester <nick> <message></code> — Sends a message to nick every hour they're around (or something. settable in config)
* .npl — Shows the time from NPL's SNTP server
 
 
** <code>.pesters snooze <nick></code> 'snooze' a pester from nick
* .nsfw <link> - for when a link isn't safe for work
 
 
** <code>.pesters <dismiss|rm|remove> <to|from> <nick></code> to stop pestering/being pestered by nick
* .pesters
 
** begiak: pester <nick> <message> — Sends a message to nick every hour they're around (or something. settable in config)
 
** .pesters snooze <nick> - 'snooze' a pester from nick
 
** .pesters <dismiss|rm|remove> <to|from> <nick> - to stop pestering/being pestered by nick
 
 
* Search commands:
 
* Search commands:
 
** The search commands are used to point other users to the output of several supported commands which are as follows:
 
** The search commands are used to point other users to the output of several supported commands which are as follows:
Line 46: Line 43:
 
*** Wikipedia (<code>.wik</code>)
 
*** Wikipedia (<code>.wik</code>)
 
*** Urban Dictionary (<code>.urb</code>)
 
*** Urban Dictionary (<code>.urb</code>)
*** Wikitionary (<code>.w</code>)
+
*** Wiktionary (<code>.w</code>)
*** DuckDuckGo Search ( <code>.search</code> )
+
*** DuckDuckGo Search (<code>.search</code>)
 
** Replace <code>.wik</code> or <code>.awik</code> with any of the above commands for appropriate output like 'svineet, "India, officially the Republic of India (Bhārat Gaṇarājya),[18][19][c] is a country in South Asia" - https://en.wikipedia.org/wiki/India' for <code>.wik India -> svineet</code>
 
** Replace <code>.wik</code> or <code>.awik</code> with any of the above commands for appropriate output like 'svineet, "India, officially the Republic of India (Bhārat Gaṇarājya),[18][19][c] is a country in South Asia" - https://en.wikipedia.org/wiki/India' for <code>.wik India -> svineet</code>
 
*** <code>.awik Begiak -> svineet</code>
 
*** <code>.awik Begiak -> svineet</code>
Line 53: Line 50:
 
*** <code>nick: .wik India</code>
 
*** <code>nick: .wik India</code>
 
*** <code>nick, .wik India</code>
 
*** <code>nick, .wik India</code>
*** <code>.awik point nick India</code>
+
*** <code>.awik India -> nick</code>
* .seen — When was the last time a user was seen?
+
* <code>.seen</code> — When was the last time a user was seen?
* .time [timezone] — Returns current time in timezone (can be a city or a time zone e.g UTC). If timezone is empty, returns current time in GMT time zone.
+
* <code>.time [timezone]</code> — Returns current time in timezone (can be a city or a time zone e.g UTC). If timezone is empty, returns current time in GMT time zone.
* .tz — Timezone converter Converts a time from one timezone to another. (e.g., .tz 335EST in CET, or .tz 335EST in London)
+
* <code>.tz</code> — Timezone converter Converts a time from one timezone to another. (e.g., .tz 335EST in CET, or .tz 335EST in London)
* .tells — See a summary of outstanding reminders you've sent to others using "begiak: tell"
+
* <code>.tells</code> — See a summary of outstanding reminders you've sent to others using "begiak: tell"
** begiak: tell <nick> <message> [**pm**] — Tells someone something the next time they say something in a channel begiak is monitoring. The **pm** option has the message sent privately.
+
** begiak: tell <nick> <message> [**pm**]</code> — Tells someone something the next time they say something in a channel begiak is monitoring. The **pm** option has the message sent privately.
** .tells <nick> — List your reminders currently queued to that nick
+
** <code>.tells <nick></code> — List your reminders currently queued to that nick
** .tells rm <num> — Delete a queued reminder using its number from .tells nick
+
** <code>.tells rm <num></code> — Delete a queued reminder using its number from .tells nick
* .alias - manage aliases
+
* <code>.alias</code> manage aliases
** .alias add <nick> — adds an alias for your nick of nick
+
** <code>.alias add <nick></code> — adds an alias for your nick of nick
** .alias rm <nick> — removes an alias for nick nick
+
** <code>.alias rm <nick></code> — removes an alias for nick nick
** .alias list <nick> — lists existing aliases for nick
+
** <code>.alias list <nick></code> — lists existing aliases for nick
* .u <char> — Search for a unicode character
+
* <code>.u <char></code> — Search for a unicode character
* .weather <city> — Get the weather for a city
+
* <code>.weather <city></code> — Get the weather for a city
* .yi — Shows whether it is currently yi or not
+
* <code>.yi</code> — Shows whether it is currently yi or not
   
 
=== Admin ===
 
=== Admin ===
 
These are admin-only, or only useful to admins.
 
These are admin-only, or only useful to admins.
* .isodb update — update the local database of ISO 639 codes
+
* <code>.isodb update</code> — update the local database of ISO 639 codes
* .greeting — Manage Greetings
+
* <code>.greeting</code> — Manage Greetings
** .greeting add <name> <message> — Add a greeting
+
** <code>.greeting add <name> <message></code> — Add a greeting
** .greeting del <name> - Delete a greeting
+
** <code>.greeting del <name></code> - Delete a greeting
* .gitserver [status|start|stop] — get the githook-server's status/start it/stop it. See [[Begiak's git plugin]] for more info.
+
* <code>.gitserver [status|start|stop]</code> — get the githook-server's status/start it/stop it. See [[Begiak's git plugin]] for more info.
* .tzdb — Manage database
+
* <code>.tzdb</code> — Manage timezone database
** .tzdb update — Updates a timezones database (admin only)
+
** <code>.tzdb update</code> — Updates a timezones database (admin only)
** .tzdb status — Returns a status of updating a timezones database
+
** <code>.tzdb status</code> — Returns a status of updating a timezones database
   
 
=== Unknown ===
 
=== Unknown ===
Line 99: Line 96:
 
* .(ml|mailinglist) poll — Poll for new messages in apertium mailing lists (this is automatically done every five minutes).
 
* .(ml|mailinglist) poll — Poll for new messages in apertium mailing lists (this is automatically done every five minutes).
 
* .(ml|mailinglist) last <list> — Get the last message in a specified list.
 
* .(ml|mailinglist) last <list> — Get the last message in a specified list.
 
== Wishlist ==
 
You can see the old wishlist [[Talk:Begiak#Old_Wishlist|here]]
 
* mediawiki plugins
 
** have better logic for text that's displayed for a page/section (need examples where it fails!)
 
*** where the first thing is <nowiki>[[…|En français]]</nowiki> (though really, we should have a real template on the wiki for translations)
 
*** where there's immediately a subsection? (cf. [[Talk:Begiak]])
 
** generalise mediawiki plugin?
 
* Pollers (svn, git, etc.)
 
** show short links to new apertium-stuff posts (poll like with commits?) ☭
 
*** alternatively: begiak lacks a filter or two, sometimes fills up channels making S/N high. begiak should detect quiet channels and not output there.
 
** svnpoller and gitpoller's lookup functions (i.e., repeat information on specific revision)
 
*** make it work
 
*** make it give a url to online commit viewer (maybe url template provided as a config option?), e.g. https://sourceforge.net/p/apertium/svn/57171/ ☭
 
* timezones
 
** better mapping of city names to timezones
 
   
 
== Help! It crashed!==
 
== Help! It crashed!==
Begiak has a known bug that causes it to repeatedly quit and rejoin. Please don't report this as an issue; we already know about it. If you know how to fix it, please do tell us, though.
+
Begiak has a known bug that causes it to repeatedly quit and rejoin. A few recent changes have reduced this, but it still occasionally occurs. Please don't report this as an issue; we already know about it. If you know how to fix it, however, please do tell us.
  +
  +
== Development ==
  +
A good tutorial on creating Phenny modules can be found [https://github.com/myano/jenni/wiki/How-to-create-a-phenny-module here]. Also, note that some commands start with a period and others start with "begiak: "; new commands should use a period.
   
 
== Administration ==
 
== Administration ==
Begiak is controlled by an init script (/etc/init.d/begiak.sh) on bytemark, and can be started, stopped, and restarted by anyone with sudo access.
+
Begiak is controlled by an init script (/etc/init.d/begiak.sh, found at [https://github.com/apertium/phenny/blob/master/init.sh]) on Bytemark, and can be started, stopped, and restarted by anyone with sudo access.
   
 
[[Category:Bots]]
 
[[Category:Bots]]

Revision as of 00:27, 13 April 2020

begiak is the IRC bot in the #apertium IRC channel. It serves several purposes, including to showcase some applications of the apertium translation API, getting information about languages and other topics, and providing various forms of reminders, as well as a couple features that are just for fun.

Background

Begiak was set up by conor_f for GCI 2012, and several modules were written and fixed by sushain, Qasim, and a number of other GCI students since then. The core code base is the mutantmonkey port to Python3 of the phenny bot. Our codebase is currently hosted at [1].

Begiak means "the eyes" in Basque.

Features

Begiak recognises the following commands.

  • .awikstats update <lang> — update the wikipage apertium-LANG/stats (note: will dump a bunch of info in private chat)
  • .follow <nick> <lg1-lg2> [follower] — Follow someone and translate as they speak. (Translations are sent as notices to the follower (follower feature is admin only!))
  • .following — List people currently being followed.
  • .iso639 <lg> — look up ISO 639-1, -2 and -3 language codes either by code or by language name. Codes sourced from Ethnologue.com (639-3) and Wikipedia (-1 and -2)
  • .isodb status — see if the database updater (.isodb update) is running
  • .issue <title> — create a new GitHub issue.
  • .listpairs <lg> — List language pairs available for apertium translation
  • .listlangs — List languages available for apertium translation
  • .t <lg1-lg2> [ | lg2-lg3 ...] <text> — Apertium translate
  • .unfollow <nick> — Stop following a user.
  • .8ball — magic 8 ball
  • .beats — Shows the internet time in Swatch beats
  • .botsnack — Give begiak a snack for being good
  • .c — Calculator using SymPy.
  • .chill — Measure the current channel chillness level.
  • .choose <choice1> <choice2> — begiak will choose one of the two options (randomly).
  • .ety — Look up the etymology of a word
  • .fcc <callsign> — Look up a callsign issued by the FCC
  • .fight <nick> — have begiak fight someone for you.
  • .hug <nick> — have begiak hug someone for you.
  • .in — Set a reminder
  • .linx <url> — Upload url to linx.li
  • .npl — Shows the time from NPL's SNTP server
  • .nsfw <link> — for when a link isn't safe for work
  • .pesters
    • begiak: pester <nick> <message> — Sends a message to nick every hour they're around (or something. settable in config)
    • .pesters snooze <nick> — 'snooze' a pester from nick
    • .pesters <dismiss|rm|remove> <to|from> <nick> — to stop pestering/being pestered by nick
  • Search commands:
    • The search commands are used to point other users to the output of several supported commands which are as follows:
      • Apertium Wiki (.awik)
      • Wikipedia (.wik)
      • Urban Dictionary (.urb)
      • Wiktionary (.w)
      • DuckDuckGo Search (.search)
    • Replace .wik or .awik with any of the above commands for appropriate output like 'svineet, "India, officially the Republic of India (Bhārat Gaṇarājya),[18][19][c] is a country in South Asia" - https://en.wikipedia.org/wiki/India' for .wik India -> svineet
      • .awik Begiak -> svineet
      • .awik Begiak → svineet
      • nick: .wik India
      • nick, .wik India
      • .awik India -> nick
  • .seen — When was the last time a user was seen?
  • .time [timezone] — Returns current time in timezone (can be a city or a time zone e.g UTC). If timezone is empty, returns current time in GMT time zone.
  • .tz — Timezone converter Converts a time from one timezone to another. (e.g., .tz 335EST in CET, or .tz 335EST in London)
  • .tells — See a summary of outstanding reminders you've sent to others using "begiak: tell"
    • begiak: tell <nick> <message> [**pm**] — Tells someone something the next time they say something in a channel begiak is monitoring. The **pm** option has the message sent privately.
    • .tells <nick> — List your reminders currently queued to that nick
    • .tells rm <num> — Delete a queued reminder using its number from .tells nick
  • .alias — manage aliases
    • .alias add <nick> — adds an alias for your nick of nick
    • .alias rm <nick> — removes an alias for nick nick
    • .alias list <nick> — lists existing aliases for nick
  • .u <char> — Search for a unicode character
  • .weather <city> — Get the weather for a city
  • .yi — Shows whether it is currently yi or not

Admin

These are admin-only, or only useful to admins.

  • .isodb update — update the local database of ISO 639 codes
  • .greeting — Manage Greetings
    • .greeting add <name> <message> — Add a greeting
    • .greeting del <name> - Delete a greeting
  • .gitserver [status|start|stop] — get the githook-server's status/start it/stop it. See Begiak's git plugin for more info.
  • .tzdb — Manage timezone database
    • .tzdb update — Updates a timezones database (admin only)
    • .tzdb status — Returns a status of updating a timezones database

Unknown

These functions/plugins either don't seem to work or need some figuring out:

  • .tfw
  • lastfm
  • mylife (.fml .mlia)
  • oblique
  • .whereis nick — Tells you nick's current status.
  • .queue — Manage lists.
    • .queue new name [item1, item2 ...] — Make a new queue
    • .queue name — Display a queue
    • .queue delete name — Delete a queue
    • .queue name add item — Add an item
    • .queue name remove item — Remove an item
    • .queue name pop — Pop an item off the queue
    • .queue name swap item1, item2 — Swap two items
  • .py — Evaluate an expression in python (This runs as a sandboxed web service, not on your computer)
  • .wikicount lg — Get the number of articles an official or incubated Wikipedia for the specified language has, given a Wikipedia code or partial language name.
  • .(ml|mailinglist) poll — Poll for new messages in apertium mailing lists (this is automatically done every five minutes).
  • .(ml|mailinglist) last <list> — Get the last message in a specified list.

Help! It crashed!

Begiak has a known bug that causes it to repeatedly quit and rejoin. A few recent changes have reduced this, but it still occasionally occurs. Please don't report this as an issue; we already know about it. If you know how to fix it, however, please do tell us.

Development

A good tutorial on creating Phenny modules can be found here. Also, note that some commands start with a period and others start with "begiak: "; new commands should use a period.

Administration

Begiak is controlled by an init script (/etc/init.d/begiak.sh, found at [2]) on Bytemark, and can be started, stopped, and restarted by anyone with sudo access.