Skip to content

Pywikibot maintenance scripts for criticalrole.miraheze.org

Notifications You must be signed in to change notification settings

eseiver/cr_miraheze_scripts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Critical Role Miraheze scripts

These pywikibot scripts are for maintaining Encyclopedia Exandria at https://criticalrole.miraheze.org. For more information about how these scripts work and setting up Python and/or Pywikibot, including creating a bot password, please see Help:VOD script on the wiki.

Requirements

Installation

Cloning pywikibot and this repo

Decide what folder you'd like to place the pywikibot folder inside, somewhere easy to access on your computer. Open your command line tool and navigate to that folder. In that location run:

git clone -b stable https://gerrit.wikimedia.org/r/pywikibot/core.git pywikibot
git clone https://github.com/eseiver/cr_miraheze_scripts pywikibot/scripts/userscripts/cr_miraheze_scripts
pip install pywikibot youtube_transcript_api beautifulsoup4

Now whenever you want to get the latest pywikibot or cr_miraheze_scripts updates, you can go into the pywikibot folder and run git pull (first running git fetch and git status to compare the two states). (To update the miraheze scripts while in the top-level pywikibot folder, add the folder location after git, such as git -C scripts/userscripts/cr_miraheze_scripts pull.) This process will not overwrite any user files you create in the next step.

Create user files

Generate the wiki-specific files you need for logging into Miraheze by following the configuration guide for third-party wikis; miraheze_family.py does not exist by default and must be created. Your login credentials will be stored in user-config.py and user-password.py.

Update user-config file

Then update your user-config.py file in the top-level pywikibot folder to include the line:

user_script_paths = ['scripts.userscripts.cr_miraheze_scripts']

Usage

To run one of these scripts, navigate to the pywikibot folder on the command line and run: python pwb.py SCRIPTNAME where SCRIPTNAME is something like vod.

Modules

Name Description
ep.py Validates episode codes and infers information from them.
cr.py Misc. helper functions & data for Critical Role Wiki.
transcript.py For converting YouTube captions to transcripts.

Scripts

Name Description
vod.py Update relevant wiki pages when a new VOD is released on YouTube.
podcast.py Update Module:Ep/PodcastSwitcher/URLs when a podcast is released.
dupes.py Interactively remove transcript duplicate lines. Also in vod.py.

About

Pywikibot maintenance scripts for criticalrole.miraheze.org

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages