PAWS

From Wikitech
Jump to navigation Jump to search
PAWS.svg


Overview

PAWS: A Web Shell (PAWS) is a Jupyter notebooks deployment hosted by Wikimedia.

PAWS is web-based and makes it possible for users to launch, publish, and fork notebooks without installing Jupyter. PAWS notebooks allow users to create and share documents that contain live code, visualizations such as graphs, rich text, etc.

Example Uses

You can find more examples in this index of public PAWS notebooks.

Getting started with PAWS

  1. Open PAWS
  2. Click the Sign in with MediaWiki button.
  3. Allow permission for PAWS to perform some actions on your behalf.
  4. It's that easy!

Create

Create a notebook.

  1. Click the New button and choose your notebook type. You can choose Python 3, Bash or R.

Share

Share your notebook using a public link.

  1. Use the Public Link button to generate a public URL, or
  2. Alter the URL manually to get the public link to your notebook: https://public.paws.wmcloud.org/User:YOURUSERNAME/YOURNOTEBOOK.ipynb

Fork

Fork an existing notebook

  1. Get the URL of another public PAWS notebook. Example: https://public.paws.wmcloud.org/YOURUSERNAME/YOURNOTEBOOK.ipynb
  2. Add ?format=raw to the end of the URL to download a raw .ipynb file. Example: https://public.paws.wmcloud.org/YOURUSERNAME/YOURNOTEBOOK.ipynb?format=raw
  3. Log into your PAWS account and use Upload button to upload this copy into your own directory.

Using PAWS

Tutorials

  • Getting started with PAWS -- A notebook based tutorial with all the basics you'll need to start, launch, and use Jupyter notebooks in PAWS.

General use

PAWS and Pywikibot

Pywikibot is a Python library and collection of tools that automate work on MediaWiki sites. Originally designed for Wikipedia, it is now used throughout the Wikimedia Foundation's projects and on many other MediaWiki wikis.

For detailed information about Pywikibot/PAWS integration, log-in, and set-up instructions see: The Pywikibot/PAWS manual.

Report bugs, request features

Source code

Maintainance and administration

Learn more about how PAWS is administered and maintained.

See also