https://github.com/gelbpunkt/aiowiki

An asynchronous python libary to get mediawiki content
https://github.com/gelbpunkt/aiowiki

Last synced: 5 days ago
JSON representation

An asynchronous python libary to get mediawiki content

• Host: GitHub
• URL: https://github.com/gelbpunkt/aiowiki
• Owner: Gelbpunkt
• License: mit
• Created: 2018-06-29T10:14:41.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-02-21T14:52:47.000Z (almost 4 years ago)
• Last Synced: 2024-11-09T00:56:42.167Z (2 months ago)
• Language: Python
• Homepage:
• Size: 91.8 KB
• Stars: 24
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# aiowiki

An asynchronous python libary to get mediawiki content

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f634a400d4ed40ec8f51b1ce0f43fd5e)](https://www.codacy.com/app/Gelbpunkt/aiowiki?utm_source=github.com&utm_medium=referral&utm_content=Gelbpunkt/aiowiki&utm_campaign=Badge_Grade)

[![CodeFactor](https://www.codefactor.io/repository/github/gelbpunkt/aiowiki/badge)](https://www.codefactor.io/repository/github/gelbpunkt/aiowiki)

[![BCH compliance](https://bettercodehub.com/edge/badge/Gelbpunkt/aiowiki?branch=master)](https://bettercodehub.com/)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FGelbpunkt%2Faiowiki.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FGelbpunkt%2Faiowiki?ref=badge_shield)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

[![CircleCI](https://img.shields.io/circleci/project/github/Gelbpunkt/aiowiki/master.svg?label=CircleCI)](https://circleci.com/gh/Gelbpunkt/aiowiki)

[![License](https://img.shields.io/pypi/l/aiowiki.svg)](https://github.com/Gelbpunkt/aiowiki/blob/master/LICENSE)

[![codecov](https://codecov.io/gh/Gelbpunkt/aiowiki/branch/master/graph/badge.svg)](https://codecov.io/gh/Gelbpunkt/aiowiki)

[![Downloads on Pypi](https://img.shields.io/pypi/dd/aiowiki.svg)](https://pypi.org/project/aiowiki/)

## Installation

It requires Python 3.6 or above and aiohttp

`pip3 install git+https://github.com/Gelbpunkt/aiowiki`

## Quick start

```python

import aiowiki

wiki = aiowiki.Wiki.wikipedia("en") # We're using the alternate constructor for pre-made Wikipedia Wikis

await wiki.login("test", "pass1234") # Logging in (optional)

pages = await wiki.get_random_pages(3) # get a list of random pages

pages = await wiki.opensearch("Monty Python") # gets page objects by search

page = wiki.get_page("aiowiki") # get a specific page

print(await page.html()) # print the pure page html

print(await page.markdown()) # print the pure page markdown (wiki code)

print(await page.text()) # print the page's text (library handles filtering of the HTML)

await page.edit("That's a nice lib!") # edit the page, automatically uses the logged in user or anonymous

await wiki.close() # the Wiki object also supports a context manager (async with) to close automatically

```

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FGelbpunkt%2Faiowiki.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FGelbpunkt%2Faiowiki?ref=badge_large)