royalnet/docs/html/searchindex.js

Search.setIndex({docnames:["apireference","index","packs/command","packs/event","packs/newpack","packs/pack","packs/star","packs/table","randomdiscoveries"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.index":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["apireference.rst","index.rst","packs/command.rst","packs/event.rst","packs/newpack.rst","packs/pack.rst","packs/star.rst","packs/table.rst","randomdiscoveries.rst"],objects:{"royalnet.alchemy":{Alchemy:[0,1,1,""],AlchemyException:[0,3,1,""],TableNotFoundError:[0,3,1,""],table_dfs:[0,4,1,""]},"royalnet.alchemy.Alchemy":{__init__:[0,2,1,""],get:[0,2,1,""],session_acm:[0,2,1,""],session_cm:[0,2,1,""]},"royalnet.bard":{BardError:[0,3,1,""],MultipleFilesError:[0,3,1,""],NotFoundError:[0,3,1,""],YtdlError:[0,3,1,""],YtdlFile:[0,1,1,""],YtdlInfo:[0,1,1,""]},"royalnet.bard.YtdlFile":{__init__:[0,2,1,""],aopen:[0,2,1,""],default_ytdl_args:[0,5,1,""],delete_asap:[0,2,1,""],download_file:[0,2,1,""],from_url:[0,2,1,""],has_info:[0,2,1,""],is_downloaded:[0,2,1,""],retrieve_info:[0,2,1,""],set_ytdlinfo_from_id3_tags:[0,2,1,""]},"royalnet.bard.YtdlInfo":{__init__:[0,2,1,""],from_url:[0,2,1,""]},"royalnet.commands":{Command:[0,1,1,""],CommandArgs:[0,1,1,""],CommandData:[0,1,1,""],CommandError:[0,3,1,""],ConfigDict:[0,1,1,""],ConfigurationError:[0,3,1,""],ExternalError:[0,3,1,""],HeraldEvent:[0,1,1,""],InvalidInputError:[0,3,1,""],KeyboardKey:[0,1,1,""],ProgramError:[0,3,1,""],UnsupportedError:[0,3,1,""],UserError:[0,3,1,""]},"royalnet.commands.Command":{alchemy:[0,2,1,""],aliases:[0,5,1,""],description:[0,5,1,""],loop:[0,2,1,""],name:[0,5,1,""],run:[0,2,1,""],syntax:[0,5,1,""]},"royalnet.commands.CommandArgs":{__getitem__:[0,2,1,""],joined:[0,2,1,""],match:[0,2,1,""],optional:[0,2,1,""]},"royalnet.commands.CommandData":{delete_invoking:[0,2,1,""],find_user:[0,2,1,""],get_author:[0,2,1,""],keyboard:[0,2,1,""],loop:[0,2,1,""],register_keyboard_key:[0,2,1,""],reply:[0,2,1,""],reply_image:[0,2,1,""],session:[0,2,1,""],session_close:[0,2,1,""],session_commit:[0,2,1,""],unregister_keyboard_key:[0,2,1,""]},"royalnet.commands.ConfigDict":{convert:[0,2,1,""]},"royalnet.commands.HeraldEvent":{alchemy:[0,2,1,""],loop:[0,2,1,""],name:[0,5,1,""],run:[0,2,1,""]},"royalnet.commands.KeyboardKey":{press:[0,2,1,""]},"royalnet.constellation":{Constellation:[0,1,1,""],PageStar:[0,1,1,""],Star:[0,1,1,""]},"royalnet.constellation.Constellation":{address:[0,5,1,""],alchemy:[0,5,1,""],call_herald_event:[0,2,1,""],events:[0,5,1,""],herald:[0,5,1,""],herald_task:[0,5,1,""],init_herald:[0,2,1,""],loop:[0,5,1,""],network_handler:[0,2,1,""],port:[0,5,1,""],register_events:[0,2,1,""],register_page_stars:[0,2,1,""],run_blocking:[0,2,1,""],run_process:[0,2,1,""],running:[0,5,1,""],starlette:[0,5,1,""],stars:[0,5,1,""]},"royalnet.constellation.PageStar":{methods:[0,2,1,""],path:[0,5,1,""]},"royalnet.constellation.Star":{Session:[0,2,1,""],alchemy:[0,2,1,""],page:[0,2,1,""],session_acm:[0,2,1,""]},"royalnet.herald":{Broadcast:[0,1,1,""],Config:[0,1,1,""],ConnectionClosedError:[0,3,1,""],HeraldError:[0,3,1,""],InvalidServerResponseError:[0,3,1,""],Link:[0,1,1,""],LinkError:[0,3,1,""],Package:[0,1,1,""],Request:[0,1,1,""],Response:[0,1,1,""],ResponseFailure:[0,1,1,""],ResponseSuccess:[0,1,1,""],Server:[0,1,1,""],ServerError:[0,3,1,""]},"royalnet.herald.Broadcast":{from_dict:[0,2,1,""],to_dict:[0,2,1,""]},"royalnet.herald.Config":{copy:[0,2,1,""],from_config:[0,2,1,""],url:[0,2,1,""]},"royalnet.herald.Link":{broadcast:[0,2,1,""],connect:[0,2,1,""],identify:[0,2,1,""],receive:[0,2,1,""],request:[0,2,1,""],run:[0,2,1,""],send:[0,2,1,""]},"royalnet.herald.Package":{__init__:[0,2,1,""],from_dict:[0,2,1,""],from_json_bytes:[0,2,1,""],from_json_string:[0,2,1,""],reply:[0,2,1,""],to_dict:[0,2,1,""],to_json_bytes:[0,2,1,""],to_json_string:[0,2,1,""]},"royalnet.herald.Request":{from_dict:[0,2,1,""],to_dict:[0,2,1,""]},"royalnet.herald.Response":{from_dict:[0,2,1,""],to_dict:[0,2,1,""]},"royalnet.herald.Server":{find_client:[0,2,1,""],find_destination:[0,2,1,""],listener:[0,2,1,""],route_package:[0,2,1,""],run:[0,2,1,""],run_blocking:[0,2,1,""],serve:[0,2,1,""]},"royalnet.serf":{Serf:[0,1,1,""],SerfError:[0,3,1,""]},"royalnet.serf.Serf":{alchemy:[0,5,1,""],call:[0,2,1,""],call_herald_event:[0,2,1,""],commands:[0,5,1,""],events:[0,5,1,""],herald:[0,5,1,""],herald_task:[0,5,1,""],identity_chain:[0,2,1,""],identity_table:[0,5,1,""],init_alchemy:[0,2,1,""],init_herald:[0,2,1,""],interface_name:[0,5,1,""],loop:[0,5,1,""],master_table:[0,5,1,""],network_handler:[0,2,1,""],prefix:[0,5,1,""],press:[0,2,1,""],register_commands:[0,2,1,""],register_events:[0,2,1,""],run:[0,2,1,""],run_process:[0,2,1,""]},"royalnet.utils":{MultiLock:[0,1,1,""],andformat:[0,4,1,""],asyncify:[0,4,1,""],from_urluuid:[0,4,1,""],init_logging:[0,4,1,""],init_sentry:[0,4,1,""],numberemojiformat:[0,4,1,""],ordinalformat:[0,4,1,""],sentry_async_wrap:[0,4,1,""],sentry_exc:[0,4,1,""],sentry_wrap:[0,4,1,""],sleep_until:[0,4,1,""],strip_tabs:[0,4,1,""],to_urluuid:[0,4,1,""],underscorize:[0,4,1,""],ytdldateformat:[0,4,1,""]},"royalnet.utils.MultiLock":{exclusive:[0,2,1,""],normal:[0,2,1,""]},royalnet:{alchemy:[0,0,0,"-"],backpack:[0,0,0,"-"],bard:[0,0,0,"-"],commands:[0,0,0,"-"],constellation:[0,0,0,"-"],herald:[0,0,0,"-"],serf:[0,0,0,"-"],utils:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","exception","Python exception"],"4":["py","function","Python function"],"5":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:exception","4":"py:function","5":"py:attribute"},terms:{"0th":0,"101st":0,"112th":0,"11th":0,"1st":0,"2nd":0,"abstract":0,"byte":0,"case":[0,2],"class":[0,2,4],"default":[0,2],"enum":4,"final":[0,2],"function":[0,2,4],"ges\u00f9":0,"import":[0,2,4],"int":0,"new":[0,5],"null":0,"return":[0,2],"short":[0,2],"static":0,"super":2,"true":[0,2],"try":[0,2],"while":[0,2,4,8],Adding:5,For:2,Has:0,Its:4,Not:[0,2],That:0,The:[0,2],Then:2,There:2,These:2,Use:[2,4],Using:[4,5],__all__:2,__getitem__:0,__init__:[0,2],__name__:2,__total_spaghetti:2,abl:[0,4],about:[0,2,4],abstracteventloop:0,accept:2,access:0,accur:[0,4],acquir:0,across:2,actual:4,add:[0,2,4,5],added:0,adding:[0,2],addit:0,addition:2,address:0,admin:0,after:4,aio:0,akin:0,al_dent:2,alchemi:4,alchemy_cfg:0,alchemy_easi:0,alchemy_hard:0,alchemyexcept:0,aldent:0,alia:0,alias:0,all:[0,2,4],allow:[0,2],also:[0,2],altern:0,alwai:2,amount:0,andformat:0,ani:[0,2],anoth:0,answer:2,anymor:0,anystr:0,anyth:4,anywher:4,aopen:0,api:[1,2],app:0,append:2,arg:[0,2],argument:0,around:0,ascend:2,assertionerror:2,assum:2,async:[0,2],asynccontextmanag:2,asyncifi:[0,2],asyncio:[0,2],asynciter:0,asyncron:[0,2],attach:[0,2],attribut:2,authent:8,author:0,autocomplet:0,autogener:0,automat:2,avail:0,available_command:2,avoid:[0,2],await:[0,2],back:2,backpack:2,banana:2,barderror:0,base64:0,base:[0,4],bbcode:2,becaus:[0,2],been:[0,2],befor:[0,2,4],begin:2,being:[0,2],between:0,bind:0,block:0,blockingli:0,bold:2,bool:0,bot:[0,2,8],both:0,brace:2,bracket:2,brief:2,broadcast:0,bug:2,build:4,button:2,call:[0,4],call_herald_ev:[0,2],callabl:0,callback:0,can:[0,2,4,5],cannot:[0,2],caption:0,carb:2,carbonara:[0,2],cate:0,caus:[0,2],central:0,certain:2,chang:2,channel:0,charact:0,chat:2,check:[0,2],choos:4,circular:4,classmethod:0,clone:4,close:[0,2],code:[0,4],coll:0,collect:0,column:2,com:2,come:2,command:5,commandarg:[0,2],commanddata:[0,2],commanderror:[0,2],comment:[2,4],commit:0,commun:0,comparis:2,compat:4,complet:0,complex:2,config:[0,2],configdict:0,configur:[0,4],configurationerror:[0,2],connect:[0,2],connectedcli:0,connectionclosederror:0,consid:2,constellation_cfg:0,contain:[0,2,4],content:[2,4],context:[0,2],contextmanag:2,convers:0,convert:0,copi:0,coroutin:0,correspond:0,could:2,counterpart:0,creat:[0,5],create_task:2,curli:2,current:0,custom:4,dai:0,data:0,databas:[0,4,5],database_uri:0,date:0,datetim:0,debug:2,declar:0,declarativemeta:0,def:2,default_ytdl_arg:0,delet:0,delete_asap:0,delete_invok:[0,2],dent:2,depend:2,depth:0,desc:2,descend:2,describ:[2,4],descript:[0,2],destin:0,destination_conv_id:0,detail:0,develop:[4,8],dict:0,dictionari:0,did:[0,2],differ:[0,2],directli:[0,2],discord:[0,2],discordserf:2,discoveri:1,displai:0,docstr:0,document:[1,3,6,7],doe:[0,2],doesn:0,don:[0,2],down:0,download:0,download_1_terabyte_of_spaghetti:2,download_fil:0,drive:2,due:2,dure:[0,2],each:0,easili:0,edit:4,effect:2,either:0,eject:2,element:[0,2],elif:2,ellipsi:0,els:[2,4],emoji:[0,2],enabl:0,encod:0,encount:0,end:0,ending_t:0,engin:[0,2],english:0,enough:[0,2],enter:2,epic:0,epoch:0,equival:2,error:0,error_if_non:0,error_if_unavail:[0,2],establish:2,even:0,event:[0,5],event_nam:[0,2],everi:[0,2],everyth:[2,4],exact:[0,2],exampl:[0,2],exc:0,except:[0,2],exceptionstar:0,exclus:0,execut:[0,2],executor:0,exist:[0,2],exit:0,expect:2,explain:0,ext:0,extern:[0,2],externalerror:[0,2],extra:0,extra_info:0,extract:0,extract_info:0,eyed3:0,facilit:2,factor:0,fail:[0,8],fals:0,famm:2,featur:[0,5],fetch:0,ffmpeg_python:0,field:[2,4],file:0,filenam:0,find:0,find_client:0,find_destin:0,find_us:0,finish:[2,4],first:[0,2,4],first_pasta:2,flag:[0,2],floppi:2,follow:4,forbidden:4,form:0,format:0,found:[0,2,8],free:2,friendli:0,from:[0,4],from_config:0,from_dict:0,from_json_byt:0,from_json_str:0,from_url:0,from_urluuid:0,further:2,gener:[0,2],get:[0,2],get_author:0,github:1,going:0,gone:0,googl:2,greater:2,group:[0,2],handl:0,handler:0,happen:0,has:[0,2],has_info:0,have:[0,2,4],heartbeat:8,herald_cfg:0,herald_task:0,heralderror:0,heraldev:0,here:[2,4,8],how:[0,4],howev:4,http:[0,2],ident:0,identifi:0,identity_chain:0,identity_t:0,ignor:2,ignoreerror:0,imag:[0,2],implement:0,includ:[2,4],independ:2,index:[0,1],info:0,inform:4,inherit:[0,2],init_alchemi:0,init_herald:0,init_log:0,init_sentri:0,initi:[0,2],inlin:2,input:0,insert:4,insid:[0,2],instal:[0,4],instanc:[0,2,4,5],instanti:0,instead:[0,2],instruct:[0,4],interact:2,interfac:[0,2],interface_nam:0,internet:0,invalid:[0,2],invalidinputerror:[0,2],invalidserverresponseerror:0,invok:0,iobas:0,is_download:0,is_open:2,isinst:2,isn:[0,2],ital:2,itali:2,item:0,iter:0,its:[0,2,4],join:[0,2],json:0,jsonabl:0,just:2,kappa:0,keep:2,kei:[0,2],keyboard:0,keyboardkei:[0,2],keyword:[0,2],kind:2,kitchen:2,kwarg:[0,2],last:0,later:2,le_epic_prank__gone_wrong_____:0,learn:4,less:0,level:0,like:[0,2],line:0,link:[0,2],link_typ:0,linkerror:0,list:[0,2],listen:0,load:5,lock:0,log:0,logging_cfg:0,look:2,loop:[0,2],made:[0,2],mai:2,main:0,maintain:0,make:2,mallllco:0,manag:0,mani:0,markup:0,master:0,master_t:0,match:[0,2],mean:[0,2],meantim:2,media:0,member:2,mention:2,messag:0,metadata:2,method:[0,2],middl:0,might:0,minimum:[0,2],miss:[0,2],mistak:2,mode:2,modul:[0,4,5],month:0,more:[0,5],msg_type:0,multilin:2,multilock:0,multipl:0,multiplefileserror:0,multiprocess:0,music:0,must:0,mycoroutin:2,name:[0,2,4],need:[2,4],network:0,network_handl:0,next:2,nid:0,no_warn:0,nobodi:0,node:0,non:0,none:[0,2],noplaylist:0,normal:[0,2],note:4,notfounderror:0,noth:[0,2],notic:2,notimpl:0,now:2,number:[0,2],numberemojiformat:0,numer:0,object:[0,2],onc:[0,2],one:[0,2],one_or_non:2,ones:2,onli:[0,2],onlin:2,open:[0,2],option:0,optional_arg:0,order_bi:2,ordin:0,ordinal_numer:0,ordinalformat:0,org:0,orm:[0,2],other:[0,2,4],otherwis:2,out:8,outtmpl:0,over:0,overrid:[0,2],own:2,pack:[0,1,2],pack_cfg:0,packag:[0,4],packagenam:4,packet:0,packs_cfg:0,page:[0,4],page_star:0,pagestar:[0,4],paltri:0,paramet:[0,2],parent:0,part:[0,2],particularli:0,pass:[0,2],pasta:0,pastapack:4,path:0,pattern:[0,2],persist:2,persistent_vari:2,ping:2,pingcommand:2,pip:0,plai:2,pleas:[0,4],poetri:4,pong:2,port:0,possibl:[0,2],post:0,postgresql:2,prank:0,prefix:0,prepar:0,present:2,press:[0,2],previou:2,previous:2,print:2,privat:2,probabl:0,problem:[0,2],procedur:[0,4],process:0,program:[0,2],programerror:[0,2],project:[0,4],properli:0,properti:[0,4],protect:2,proto:0,provid:0,psycopg2:0,put:0,pypi:[0,4],python:[2,4,5],quiet:0,rais:0,random:[0,1],rbt:2,read:[0,4],reason:8,receiv:[0,2],reciev:0,recogn:2,recommend:[2,4],recreat:0,refer:[1,2],regex:0,regist:0,register_command:0,register_ev:0,register_keyboard_kei:0,register_page_star:0,relat:0,relationship:0,rememb:2,remot:[0,4],renam:4,render:[0,2],replac:0,repli:0,reply_imag:0,report:0,repres:[0,2],represent:0,request:[0,2],request_handl:0,requestedpasta:2,requir:[0,2],require_at_least:[0,2],required_arg:0,resourc:0,respect:2,respons:0,responsefailur:0,responsesuccess:0,rest:[0,2,4],restart:2,result:0,retriev:0,retrieve_for_url:0,retrieve_info:0,right_now:2,role:2,rout:[0,4],route_packag:0,row:[0,2],royalherald:0,royalnet:[0,2,4],rsd:2,rst:2,run:[0,4],run_block:0,run_process:0,safe:0,same:2,schedul:2,schema:0,scope:2,screen:2,script:2,search:0,second:[0,2],second_pasta:2,secret:0,section:[2,3,6,7],secur:0,see:[2,4],select:0,self:[0,2],send:[0,2],sensei:0,sent:[0,2],sentri:0,sentry_async_wrap:0,sentry_cfg:0,sentry_exc:0,sentry_wrap:0,separ:[0,2],sequenc:0,serferror:0,serv:[0,2],server:[0,2],servererror:0,servic:2,session:[0,2],session_acm:0,session_clos:0,session_cm:0,session_commit:0,set:[0,2,4],set_ytdlinfo_from_id3_tag:0,shortcut:0,should:[0,2,4],shouldn:0,side:2,significantli:0,simpl:2,simultan:0,singl:[0,2],six:4,sleep:[0,2],sleep_until:0,slower:0,small:[0,2],some:[0,2,8],someth:[0,2],somewher:0,soon:0,sort:2,sourc:[0,4],source_conv_id:0,space:[0,2],spaggia:0,spaghetti:[0,2],spaghetticommand:2,spaghettipack:2,spaghi:2,special:2,specif:[0,2],specifi:[0,2],sphinx:0,sql:[0,4],sqlalchemi:[0,2,4],squar:2,stai:[0,2],star:[0,5],starlett:0,start:0,starting_t:0,statement:0,steffo:0,step:2,stop:[2,8],store:2,str:[0,2],string:0,strip_tab:0,stuff:0,subclass:2,submodul:0,subpackag:0,subset:2,success:0,support:[0,2],syntax:[0,2],tabl:[0,2,5],table_df:0,tablenotfounderror:0,take:2,target:0,task:[0,2],telegram:[0,2],telegramserf:2,tell:2,templat:4,text:[0,2],than:[0,2],thei:[0,2],them:[0,2,4],thi:[0,2,3,4,6,7],thing:[2,4,8],think:2,thought:2,thread:0,through:[0,2],time:[0,2,8],titl:0,to_dict:0,to_json_byt:0,to_json_str:0,to_urluuid:0,todo:4,toml:2,too:[0,2,4],tool:4,top:2,tri:2,trigger:0,tupl:[0,2],two:[0,2],type:[0,2],unavail:2,underscor:0,undescrib:0,unexpectedli:0,unicod:0,union:[0,2],unregister_keyboard_kei:0,unsupportederror:[0,2],until:[0,2],upload:4,uri:0,url:[0,2],use:[0,2,4],used:[0,2,4],useful:0,user:[0,2,4],usererror:[0,2],usernam:2,uses:[0,4],using:[0,2,4],usual:0,utf:0,util:2,uuid:0,uvicorn:0,valid:2,valu:[0,2],variabl:2,video:0,view:2,viktya:0,virtualenv:4,wai:[0,2],wait:[0,2],want:[0,2],wasn:[0,2],web:0,webpag:[0,5],webserv:[0,4],websit:[0,2],websocket:0,websocketserverprotocol:0,weird:0,welcom:1,went:0,were:[0,2,8],what:[0,2],when:[0,2],whenev:2,where:0,which:[0,2],wiki:0,wikipedia:0,without:4,won:[0,2],word:0,work:[0,2],workspac:4,would:2,wrap:2,wrapper:0,wrong:[0,2],year:0,yet:[0,3,6,7],you:[0,2,4],your:[2,4],youtube_dl:0,youtubedl:0,ytdl_arg:0,ytdldateformat:0,ytdlerror:0,ytdlfile:0,ytdlinfo:0,yyyi:0,yyyymmdd:0},titles:["API Reference","Royalnet","Creating a new Command","Using Events","Creating a new Pack","Royalnet Packs","Adding a Star to the Pack","Using Tables and databases","Random discoveries"],titleterms:{"new":[2,4],Adding:[2,4,6],The:4,Using:[2,3,7],access:2,alchemi:[0,2],api:0,argument:2,avail:2,backpack:0,bard:0,between:2,call:2,callback:2,code:[2,8],command:[0,2,4],configur:2,constel:0,coroutin:2,creat:[2,4],data:2,databas:[2,7],delet:2,depend:4,direct:2,discord:8,discoveri:8,displai:2,distinguish:2,error:[2,8],event:[2,3,4],examplepack:4,express:2,fetch:2,file:[2,4],filter:2,folder:4,format:2,from:2,full:2,herald:0,invok:2,job:2,keyboard:2,link:1,messag:2,more:2,multipl:2,oper:2,option:2,order:2,pack:[4,5,6],platform:2,prerequisit:4,publish:4,pyproject:4,queri:2,rais:2,random:8,read:2,readm:4,refer:0,regular:2,repeat:2,repli:2,repositori:4,result:2,royalnet:[1,5],run:2,serf:[0,2],share:2,slow:2,some:1,star:[4,6],start:2,string:2,tabl:[4,7],tag:2,toml:4,type:4,undocu:8,updat:4,useful:1,util:[0,4],websocket:8}})