ananas The Python Bot Framework for Mastodon开源项目

AaasWhatisAaas?

Aaasallowsyoutowritesimple(orcomplicated!)mastodobotswithouthavigtorewritecofigfileloadig,iterval-basedpostig,scheduledpostig,auto-replyig,adsoo.

Somebotsareassimpleasacofiguratiofile:

Butit'seasytowriteoewithcustomizedbehavior:

Rumultiplebotsomultipleistacesoutofasiglecofigfile:

AdusetheDEFAULTsectiotosharecommocofiguratiooptiosbetweethem:

Theaaaspippackagecomeswithascripttohelpyoumaageyourbots.

Simplygiveitacofigfileadit'llloadyourbotsadclosethemsafelywheitreceivesakeyboarditerrupt,SIGINT,SIGTERM,orSIGKILL.

Ifyouhave'tspecifiedaclietid/secretoraccesstoke,thescriptwillexitulessyouruitwiththe--iteractiveflag,whichallowsittopromptyoufortheistacelogiiformatio.(Theolypartoftheiputyoueterherethat'sstoredithecofigfileistheistaceame--theemailadpasswordareolyusedtogeeratetheaccesstoke).

ThefollowigfieldsareiterpretedbythePieappleBotbaseclasssadwillworkforeverybot:

class:thefully-specifiedpythoclassthattheruerscriptshouldistatiatetostartyourbot.e.g."aaas.default.TraceryBot"

domai¹:thedomaioftheistacetorutheboto.Mustsupporthttpscoectios.Olyicludethedomai,oprotocolorslashes.e.g."mastodo.social"

cliet_id¹,cliet_secret¹:thetokesthattheistaceusestoidetifywhatclietthisbotispostigfrom/as.Willbeusedtodetermiewhat'sdisplayedudereathallthepostsmadebythisbot.

access_toke¹:theaccesstokeusedtoautheticateAPIrequestswiththeistace.Makesurethisissecret,do'tdistributecofigfileswiththisfieldfilledoutorpeoplewillbeabletopostudertheaccoutthistokewascreatedwith.

admi:thefulluserame(withoutleadig@)oftheusertoDMerrorreportsto.Cabeleftuspecified,butisusefulforkeepigaeyeothehealthofthebotwithoutcostatlymoitorigthescriptlogs.e.g.admi@example.tow

¹:Filledoutautomaticallyifthebotisruiiteractivemode.

Additioalfieldsarespecifictothetypeofbot,refertothedocumetatioforthebot'sclassformoreiformatioaboutthefieldsitexpects.

Custombotclassesshouldbesubclassesofaaas.PieappleBot.Ifyouoverride__iit__,besuretocallthebaseclass's__iit__.

Iorderforthebottodoaythig,youshouldaddamethoddecoratedwithatleastoeofthefollowigdecorators:

@aaas.reply:Callsthedecoratedfuctiowhethebotismetioedbyayotheruser.Decoratortakesoparameters,butshouldolybecalledofuctiosmatchigthissigature:defreply_f(self,metio,user).metiowillbethedictioarycorrespodigtothestatuscotaiigthemetio(asreturedbythemastodoAPI,userwillbethedictioarycorrespodigtotheuserthatmetioedthebot.

@aaas.iterval(secs):Callsthedecoratedfuctioeverysecssecods,startigwhethebotisiitialized.Foritervalslogertha~ahour,youmaywattouse@scheduleistead.e.g.@aaas.iterval(60)

@aaas.schedule(**kwargs):Allowsyoutoschedule,cro-style,thedecoratedfuctio.Acceptedkeywordsare"secod","miute","hour","day_of_week"or"day_of_moth"(butotboth),"moth",ad"year".Ifayofthesekeywordsareotspecified,theywillbetreatedlikecrotreatsa*,thatis,aslogasthetimematchestheothervalues,ayvaluewillbeaccepted.Speakigofwhich,thecro-likesytax"*"aswellas"*/3"arebothaccepted,adwillexpadtotheexpectedthig:forexample,schedule(hour="*/2",miute="*/10")willpostevery10miutesdurighourswhicharemultiplesof2.

@aaas.hourly(miute=0),@aaas.daily(hour=0,miute=0):Shortcutsfor@aaas.schedule()thatcallthedecoratedfuctiooceahouratthespecifiedmiuteoroceadayatthespecifiedhouradmiute.Ifparametersareomittedthey'llpostatthetopofthehourormidight(UTC).

@aaas.error_reporter:specifiescustombehaviorforreportigerrors.Thedecoratedfuctioshouldmatchthissigature:deferr(self,error)whereerrorisastrigrepresetatiooftheerror.

Youcaalsodefiethefollowigfuctiosadtheywillbecalledattherelevatpoitsithebot'slifecycle:

iit(self):calledbeforethecofiguratiofilehasbeeloaded,sothatyoucasetdefaultvaluesforcofigfieldsicasethecofigfiledoes'tspecifythem.

start(self):calledafteralloftheiteralPieappleBotiitializatioiscompleteadthemastodoAPIisreadytouse.Agoodplacetoloadfilesspecifiedithecofig,postastartupotice,orotherwisedobot-specificsetup.

stop(self):calledwhethebothasreceivedashutdowsigaladeedstostop.Thecofigfilewillbesavedafterthis,soifyoueedtomakeaylastmiutechagestothecofig,dothathere.

Allofthecofiguratiofieldsforthecurretbotareavailablethroughtheself.cofigobject,whichexposesthemwithbothfield-accessorsytaxaddictioary-accessorsytax,forexample:

Thesecaberead(togettheuser'scofiguratiodata)orwritteto(toaffectthecofigfileoextsave)ordeleted(toremovethatfieldfromthecofigfile).

Youcacallself.cofig.load()togetthelatestvaluesfromthecofigfile.loadtakesaoptioalparameterame,whichistheameofthesectiotoloadithecofigfileicaseyouwattoloadadifferetoethathebotwasstartedwith.

Youcaalsocallself.cofig.save()towriteaychagesmadesicethelastloadbacktothecofigfile.

Notethatifyoucallself.cofig.load()durigbotoperatio,withoutfirstcalligself.cofig.save(),youwilldiscardaychagesmadetothecofiguratiosicethelastload.

Youcadistributebotshoweveryouwat;aslogastheclassisavailableisomemoduleipytho'ssys.pathoramoduleaccessiblefromthecurretdirectory,theruerscriptwillbeabletoloadit.

Ifyouthikyourbotmightbegeerallyusefultootherpeople,feelfreetocreateapullrequestothisrepositorytogetitaddedtothecollectioofdefaultbots.

Questios?PigmeoMastodoat@chr@cybre.spaceorshootmeaemailatchr@cybre.spaceadI'llaswerasbestIca!