Skip to main content

CITi Wiki pages editing with Python made easy.

Project description

codecov CircleCI PyPI version

Python script to easily edit pages on CITi’s Wiki directly from shell or using a Markdown (.md) file. Currently, our Wiki is made using MediaWiki.

Installation

$ pip install citi-wikibot

Usage

Note: Keep in mind that every command will overwrite the current page content with the one you provide.

Quickstart

  1. Just initialize your Wikibot
  2. Use one of the commands, it’s that simple :sparkles:

Editing a page directly from the shell

$ python
>>> from wikibot import Wikibot
>>> bot = Wikibot('username', 'password', 'page_title')
>>> bot.edit_page('== My title ==\nHello world!')

Editing a page from a Markdown file

Important: It’s recommended that you run the script in the folder your file is located
$ ls
notes.md
$ python
>>> from wikibot import Wikibot
>>> bot = Wikibot('username', 'password', 'page_title')
>>> bot.edit_page_from_file('notes.md')

Gets the Homepage from GitHub wiki of your repository

Automatically gets your GitHub wiki homepage (example), parses it and edits the page on CITi Wiki (result).

You must declare your personal access token from GitHub in a variable called GITHUB_TOKEN in order to use this command.

$ GITHUB_TOKEN="mypersonalaccesstoken123"
$ python
>>> from wikibot import Wikibot
>>> bot = Wikibot('username', 'password', 'page_title')
>>> bot.edit_page_from_github('my_repository')
GitHub's wiki homepage from my_repository successfully loaded and edited!
Check it here: http://wiki.citi.org.br/index.php?title=insert_page

Reference

edit_page(content)

  • content (string): The content you want to put in the page. Note that it will overwrite the current one! It accepts Wikicode (Wikipedia and MediaWiki format).

    Example:

    from wikibot import Wikibot
    
    bot = Wikibot('myusername', '123', 'My_Page')
    bot.edit_page('*Hello* world!')
    

edit_page_from_file(file)

  • file (string): The file name you want to load. It must be in Markdown format!

    Example:

    from wikibot import Wikibot
    
    bot = Wikibot('myusername', '123', 'My_Page')
    bot.edit_page_from_file('notes.md')
    

edit_page_from_github(repo)

  • repo (string): The name of your repository. It needs to have a Wiki. The script will automatically search in citi-ufpe’s organization.

    Remember to declare your GITHUB_TOKEN environment variable! Instructions above in Usage.

    Example:

    from wikibot import Wikibot
    
    bot = Wikibot('myusername', '123', 'My_Page')
    bot.edit_page_from_github('my-repo')
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
citi-wikibot-0.4.14.tar.gz (4.3 kB) Copy SHA256 hash SHA256 Source None May 31, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page