Metadata-Version: 2.1
Name: Wikipedia-API
Version: 0.5.0
Summary: Python Wrapper for Wikipedia
Home-page: https://github.com/martin-majlis/Wikipedia-API
Author: Martin Majlis
Author-email: martin@majlis.cz
License: MIT
Download-URL: https://github.com/martin-majlis/Wikipedia-API/archive/master.tar.gz
Description: Wikipedia API
        =============
        
        ``Wikipedia-API`` is easy to use Python wrapper for `Wikipedias'`_ API. It supports extracting texts, sections, links, categories, translations, etc from Wikipedia. Documentation provides code snippets for the most common use cases.
        
        .. _Wikipedias': https://www.mediawiki.org/wiki/API:Main_page
        
        |build-status| |docs| |cc-coverage| |version| |pyversions| |github-stars-flat|
        
        Installation
        ------------
        
        This package requires at least Python 3.4 to install because it's using IntEnum.
        
        .. code-block:: python
        
            pip3 install wikipedia-api
        
        
        Usage
        -----
        
        Goal of ``Wikipedia-API`` is to provide simple and easy to use API for retrieving informations from Wikipedia. Bellow are examples of common use cases.
        
        Importing
        ~~~~~~~~~
        
        .. code-block:: python
        
        	import wikipediaapi
        
        How To Get Single Page
        ~~~~~~~~~~~~~~~~~~~~~~
        
        Getting single page is straightforward. You have to initialize ``Wikipedia`` object and ask for page by its name.
        It's parameter language has be one of `supported languages`_.
        
        .. _supported languages: http://meta.wikimedia.org/wiki/List_of_Wikipedias
        
        
        .. code-block:: python
        
            import wikipediaapi
        	wiki_wiki = wikipediaapi.Wikipedia('en')
        
        	page_py = wiki_wiki.page('Python_(programming_language)')
        
        
        How To Check If Wiki Page Exists
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        For checking, whether page exists, you can use function ``exists``.
        
        .. code-block:: python
        
        	page_py = wiki_wiki.page('Python_(programming_language)')
        	print("Page - Exists: %s" % page_py.exists())
        	# Page - Exists: True
        
        	page_missing = wiki_wiki.page('NonExistingPageWithStrangeName')
        	print("Page - Exists: %s" % 	page_missing.exists())
        	# Page - Exists: False
        
        How To Get Page Summary
        ~~~~~~~~~~~~~~~~~~~~~~~
        
        Class ``WikipediaPage`` has property ``summary``, which returns description of Wiki page.
        
        .. code-block:: python
        
        
            import wikipediaapi
        	wiki_wiki = wikipediaapi.Wikipedia('en')
        
        	print("Page - Title: %s" % page_py.title)
        	# Page - Title: Python (programming language)
        
        	print("Page - Summary: %s" % page_py.summary[0:60])
        	# Page - Summary: Python is a widely used high-level programming language for
        
        
        How To Get Page URL
        ~~~~~~~~~~~~~~~~~~~
        
        ``WikipediaPage`` has two properties with URL of the page. It is ``fullurl`` and ``canonicalurl``.
        
        .. code-block:: python
        
        	print(page_py.fullurl)
        	# https://en.wikipedia.org/wiki/Python_(programming_language)
        
        	print(page_py.canonicalurl)
        	# https://en.wikipedia.org/wiki/Python_(programming_language)
        
        How To Get Full Text
        ~~~~~~~~~~~~~~~~~~~~
        
        To get full text of Wikipedia page you should use property ``text`` which constructs text of the page
        as concatanation of summary and sections with their titles and texts.
        
        .. code-block:: python
        
        	wiki_wiki = wikipediaapi.Wikipedia(
        		language='en',
        		extract_format=wikipediaapi.ExtractFormat.WIKI
        	)
        
        	p_wiki = wiki_wiki.page("Test 1")
        	print(p_wiki.text)
        	# Summary
        	# Section 1
        	# Text of section 1
        	# Section 1.1
        	# Text of section 1.1
        	# ...
        
        
        	wiki_html = wikipediaapi.Wikipedia(
        		language='en',
        		extract_format=wikipediaapi.ExtractFormat.HTML
        	)
        	p_html = wiki_html.page("Test 1")
        	print(p_html.text)
        	# <p>Summary</p>
        	# <h2>Section 1</h2>
        	# <p>Text of section 1</p>
        	# <h3>Section 1.1</h3>
        	# <p>Text of section 1.1</p>
        	# ...
        
        How To Get Page Sections
        ~~~~~~~~~~~~~~~~~~~~~~~~
        
        To get all top level sections of page, you have to use property ``sections``. It returns list of
        ``WikipediaPageSection``, so you have to use recursion to get all subsections.
        
        .. code-block:: python
        
        	def print_sections(sections, level=0):
        		for s in sections:
        			print("%s: %s - %s" % ("*" * (level + 1), s.title, s.text[0:40]))
        			print_sections(s.sections, level + 1)
        
        
        	print_sections(page_py.sections)
        	# *: History - Python was conceived in the late 1980s, 
        	# *: Features and philosophy - Python is a multi-paradigm programming l
        	# *: Syntax and semantics - Python is meant to be an easily readable
        	# **: Indentation - Python uses whitespace indentation, rath
        	# **: Statements and control flow - Python's statements include (among other
        	# **: Expressions - Some Python expressions are similar to l
        
        How To Get Page In Other Languages
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        If you want to get other translations of given page, you should use property ``langlinks``. It is map,
        where key is language code and value is ``WikipediaPage``.
        
        .. code-block:: python
        
        	def print_langlinks(page):
        		langlinks = page.langlinks
        		for k in sorted(langlinks.keys()):
        		    v = langlinks[k]
        		    print("%s: %s - %s: %s" % (k, v.language, v.title, v.fullurl))
        
        	print_langlinks(page_py)
        	# af: af - Python (programmeertaal): https://af.wikipedia.org/wiki/Python_(programmeertaal)
        	# als: als - Python (Programmiersprache): https://als.wikipedia.org/wiki/Python_(Programmiersprache)
        	# an: an - Python: https://an.wikipedia.org/wiki/Python
        	# ar: ar - بايثون: https://ar.wikipedia.org/wiki/%D8%A8%D8%A7%D9%8A%D8%AB%D9%88%D9%86
        	# as: as - পাইথন: https://as.wikipedia.org/wiki/%E0%A6%AA%E0%A6%BE%E0%A6%87%E0%A6%A5%E0%A6%A8
        
        	page_py_cs = page_py.langlinks['cs']
        	print("Page - Summary: %s" % page_py_cs.summary[0:60])
        	# Page - Summary: Python (anglická výslovnost [ˈpaiθtən]) je vysokoúrovňový sk
        
        How To Get Links To Other Pages
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        If you want to get all links to other wiki pages from given page, you need to use property ``links``.
        It's map, where key is page title and value is ``WikipediaPage``.
        
        .. code-block:: python
        
        	def print_links(page):
        		links = page.links
        		for title in sorted(links.keys()):
        		    print("%s: %s" % (title, links[title]))
        
        	print_links(page_py)
        	# 3ds Max: 3ds Max (id: ??, ns: 0)
        	# ?:: ?: (id: ??, ns: 0)
        	# ABC (programming language): ABC (programming language) (id: ??, ns: 0)
        	# ALGOL 68: ALGOL 68 (id: ??, ns: 0)
        	# Abaqus: Abaqus (id: ??, ns: 0)
        	# ...
        
        How To Get Page Categories
        ~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        If you want to get all categories under which page belongs, you should use property ``categories``.
        It's map, where key is category title and value is ``WikipediaPage``.
        
        .. code-block:: python
        
        	def print_categories(page):
        		categories = page.categories
        		for title in sorted(categories.keys()):
        		    print("%s: %s" % (title, categories[title]))
        
        
        	print("Categories")
        	print_categories(page_py)
        	# Category:All articles containing potentially dated statements: ...
        	# Category:All articles with unsourced statements: ...
        	# Category:Articles containing potentially dated statements from August 2016: ...
        	# Category:Articles containing potentially dated statements from March 2017: ...
        	# Category:Articles containing potentially dated statements from September 2017: ...
        
        How To Get All Pages From Category
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        To get all pages from given category, you should use property ``categorymembers``. It returns all members of given category.
        You have to implement recursion and deduplication by yourself.
        
        .. code-block:: python
        
        	def print_categorymembers(categorymembers, level=0, max_level=1):
        		for c in categorymembers.values():
        		    print("%s: %s (ns: %d)" % ("*" * (level + 1), c.title, c.ns))
        		    if c.ns == wikipediaapi.Namespace.CATEGORY and level < max_level:
        		        print_categorymembers(c.categorymembers, level=level + 1, max_level=max_level)
        
        
        	cat = wiki_wiki.page("Category:Physics")
        	print("Category members: Category:Physics")
        	print_categorymembers(cat.categorymembers)
        
        	# Category members: Category:Physics
        	# * Statistical mechanics (ns: 0)
        	# * Category:Physical quantities (ns: 14)
        	# ** Refractive index (ns: 0)
        	# ** Vapor quality (ns: 0)
        	# ** Electric susceptibility (ns: 0)
        	# ** Specific weight (ns: 0)
        	# ** Category:Viscosity (ns: 14)
        	# *** Brookfield Engineering (ns: 0)
        
        How To See Underlying API Call
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        If you have problems with retrieving data you can get URL of undrerlying API call.
        This will help you determine if the problem is in the library or somewhere else.
        
        .. code-block:: python
        
            import wikipediaapi
            import sys
            wikipediaapi.log.setLevel(level=wikipediaapi.logging.DEBUG)
        
            # Set handler if you use Python in interactive mode
            out_hdlr = wikipediaapi.logging.StreamHandler(sys.stderr)
            out_hdlr.setFormatter(wikipediaapi.logging.Formatter('%(asctime)s %(message)s'))
            out_hdlr.setLevel(wikipediaapi.logging.DEBUG)
            wikipediaapi.log.addHandler(out_hdlr)
        
            wiki = wikipediaapi.Wikipedia(language='en')
        
            page_ostrava = wiki.page('Ostrava')
            print(page_ostrava.summary)
            # logger prints out: Request URL: http://en.wikipedia.org/w/api.php?action=query&prop=extracts&titles=Ostrava&explaintext=1&exsectionformat=wiki
        
        External Links
        --------------
        
        * `GitHub`_
        * `PyPi`_
        * `Travis`_
        * `ReadTheDocs`_
        
        .. _GitHub: https://github.com/martin-majlis/Wikipedia-API/
        .. _PyPi: https://pypi.python.org/pypi/Wikipedia-API/
        .. _Travis: https://travis-ci.org/martin-majlis/Wikipedia-API/
        .. _ReadTheDocs: http://wikipedia-api.readthedocs.io/
        
        Other Badges
        ------------
        
        |cc-badge| |cc-issues| |coveralls| |version| |pyversions| |implementations|
        |github-downloads| |github-tag| |github-release|
        |github-commits-since-latest| |github-forks| |github-stars| |github-watches|
        |github-commit-activity| |github-last-commit| |github-code-size| |github-repo-size|
        |pypi-license| |pypi-wheel| |pypi-format| |pypi-pyversions| |pypi-implementations|
        |pypi-status| |pypi-downloads-dd| |pypi-downloads-dw| |pypi-downloads-dm|
        |libraries-io-sourcerank| |libraries-io-dependent-repos|
        
        
        Other Pages
        -----------
        
        
        
        
        .. |build-status| image:: https://travis-ci.org/martin-majlis/Wikipedia-API.svg?branch=master
            :alt: build status
            :target: https://travis-ci.org/martin-majlis/Wikipedia-API
        
        .. |docs| image:: https://readthedocs.org/projects/wikipedia-api/badge/?version=latest
            :target: http://wikipedia-api.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. |cc-badge| image:: https://codeclimate.com/github/martin-majlis/Wikipedia-API/badges/gpa.svg
            :target: https://codeclimate.com/github/martin-majlis/Wikipedia-API
            :alt: Code Climate
        
        .. |cc-issues| image:: https://codeclimate.com/github/martin-majlis/Wikipedia-API/badges/issue_count.svg
            :target: https://codeclimate.com/github/martin-majlis/Wikipedia-API
            :alt: Issue Count
        
        .. |cc-coverage| image:: https://api.codeclimate.com/v1/badges/6e2c24d72438b39e5c26/test_coverage
            :target: https://codeclimate.com/github/martin-majlis/Wikipedia-API
            :alt: Test Coverage
        
        .. |coveralls| image:: https://coveralls.io/repos/github/martin-majlis/Wikipedia-API/badge.svg?branch=master
        	:target: https://coveralls.io/github/martin-majlis/Wikipedia-API?branch=master
        	:alt: Coveralls
        
        .. |version| image:: https://img.shields.io/pypi/v/wikipedia-api.svg?style=flat
        	:target: https://pypi.python.org/pypi/Wikipedia-API
        	:alt: Version
        
        .. |pyversions| image:: https://img.shields.io/pypi/pyversions/wikipedia-api.svg?style=flat
        	:target: https://pypi.python.org/pypi/Wikipedia-API
        	:alt: Py Versions
        
        .. |implementations| image:: https://img.shields.io/pypi/implementation/wikipedia-api.svg?style=flat
            :target: https://pypi.python.org/pypi/Wikipedia-API
        	:alt: Implementations
        
        .. |github-downloads| image:: https://img.shields.io/github/downloads/martin-majlis/Wikipedia-API/total.svg
        	:target: https://github.com/martin-majlis/Wikipedia-API/releases
        	:alt: Downloads
        
        .. |github-tag| image:: https://img.shields.io/github/tag/martin-majlis/Wikipedia-API.svg
        	:target: https://github.com/martin-majlis/Wikipedia-API/tags
        	:alt: Tags
        
        .. |github-release| image:: https://img.shields.io/github/release/martin-majlis/Wikipedia-API.svg
        	:target: https://github.com/martin-majlis/Wikipedia-API/
        
        .. |github-commits-since-latest| image:: https://img.shields.io/github/commits-since/martin-majlis/Wikipedia-API/latest.svg
        	:target: https://github.com/martin-majlis/Wikipedia-API/
        	:alt: Github commits (since latest release)
        
        .. |github-forks| image:: https://img.shields.io/github/forks/martin-majlis/Wikipedia-API.svg?style=social&label=Fork
        	:target: https://github.com/martin-majlis/Wikipedia-API/
        	:alt: GitHub forks
        
        .. |github-stars| image:: https://img.shields.io/github/stars/martin-majlis/Wikipedia-API.svg?style=social&label=Stars
        	:target: https://github.com/martin-majlis/Wikipedia-API/
        	:alt: GitHub stars
        
        .. |github-stars-flat| image:: https://img.shields.io/github/stars/martin-majlis/Wikipedia-API.svg?style=flat&label=Stars
        	:target: https://github.com/martin-majlis/Wikipedia-API/
        	:alt: GitHub stars
        
        .. |github-watches| image:: https://img.shields.io/github/watchers/martin-majlis/Wikipedia-API.svg?style=social&label=Watch
        	:target: https://github.com/martin-majlis/Wikipedia-API/
        	:alt: GitHub watchers
        
        .. |github-commit-activity| image:: https://img.shields.io/github/commit-activity/y/martin-majlis/Wikipedia-API.svg
        	:target: https://github.com/martin-majlis/Wikipedia-API/commits/master
        	:alt: GitHub commit activity the past week, 4 weeks, year
        
        .. |github-last-commit| image:: https://img.shields.io/github/commits/martin-majlis/Wikipedia-API/last.svg
        	:target: https://github.com/martin-majlis/Wikipedia-API/
        	:alt: Last commit
        
        .. |github-code-size| image:: https://img.shields.io/github/languages/code-size/martin-majlis/Wikipedia-API.svg
        	:target: https://github.com/martin-majlis/Wikipedia-API/
        	:alt: GitHub code size in bytes
        
        .. |github-repo-size| image:: https://img.shields.io/github/repo-size/martin-majlis/Wikipedia-API.svg
        	:target: https://github.com/martin-majlis/Wikipedia-API/
        	:alt: GitHub repo size in bytes
        
        .. |pypi-license| image:: https://img.shields.io/pypi/l/Wikipedia-API.svg
        	:target: https://pypi.python.org/pypi/Wikipedia-API/
        	:alt: PyPi License
        
        .. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/Wikipedia-API.svg
        	:target: https://pypi.python.org/pypi/Wikipedia-API/
        	:alt: PyPi Wheel
        
        .. |pypi-format| image:: https://img.shields.io/pypi/format/Wikipedia-API.svg
        	:target: https://pypi.python.org/pypi/Wikipedia-API/
        	:alt: PyPi Format
        
        .. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/Wikipedia-API.svg
        	:target: https://pypi.python.org/pypi/Wikipedia-API/
        	:alt: PyPi PyVersions
        
        .. |pypi-implementations| image:: https://img.shields.io/pypi/implementation/Wikipedia-API.svg
        	:target: https://pypi.python.org/pypi/Wikipedia-API/
        	:alt: PyPi Implementations
        
        .. |pypi-status| image:: https://img.shields.io/pypi/status/Wikipedia-API.svg
        	:target: https://pypi.python.org/pypi/Wikipedia-API/
        	:alt: PyPi Status
        
        .. |pypi-downloads-dd| image:: https://img.shields.io/pypi/dd/Wikipedia-API.svg
        	:target: https://pypi.python.org/pypi/Wikipedia-API/
        	:alt: PyPi Downloads - Day
        
        .. |pypi-downloads-dw| image:: https://img.shields.io/pypi/dw/Wikipedia-API.svg
        	:target: https://pypi.python.org/pypi/Wikipedia-API/
        	:alt: PyPi Downloads - Week
        
        .. |pypi-downloads-dm| image:: https://img.shields.io/pypi/dm/Wikipedia-API.svg
        	:target: https://pypi.python.org/pypi/Wikipedia-API/
        	:alt: PyPi Downloads - Month
        
        .. |libraries-io-sourcerank| image:: https://img.shields.io/librariesio/sourcerank/pypi/Wikipedia-API.svg
        	:target: https://libraries.io/pypi/Wikipedia-API
        	:alt: Libraries.io - SourceRank
        
        .. |libraries-io-dependent-repos| image:: https://img.shields.io/librariesio/dependent-repos/pypi/Wikipedia-API.svg
        	:target: https://libraries.io/pypi/Wikipedia-API
        	:alt: Libraries.io - Dependent Repos
        
        
        
        
        Changelog
        =========
        
        0.5.0
        -----
        
        * Allows modifying API call parameters
        * Fixes `Issue 16`_ - hidden categories
        * Fixes `Issue 21`_ - summary extraction
        
        .. _Issue 16: https://github.com/martin-majlis/Wikipedia-API/issues/16
        .. _Issue 21: https://github.com/martin-majlis/Wikipedia-API/issues/21
        
        
        0.4.5
        -----
        
        * Handles missing sections correctly
        * Fixes `Issue 20`_
        
        .. _Issue 20: https://github.com/martin-majlis/Wikipedia-API/issues/20
        
        
        0.4.4
        -----
        * Uses HTTPS directly instead of HTTP to avoid redirect
        
        0.4.3
        -----
        * Correctly extracts text from pages without sections
        * Adds support for quoted page titles
        
        .. code:: python
        
            api = wikipediaapi.Wikipedia(
                language='hi',
            )
            python = api.article(
                title='%E0%A4%AA%E0%A4%BE%E0%A4%87%E0%A4%A5%E0%A4%A8',
                unquote=True,
            )
            print(python.summary)
        
        0.4.2
        -----
        * Adds support for Python 3.4 by not using f-strings
        
        0.4.1
        -----
        * Uses code style enforced by flake8
        * Increased code coverage
        
        0.4.0
        -----
        * Uses type annotations => minimal requirement is now Python 3.5
        * Adds possibility to use more parameters for `request`_. For example:
        
        .. code:: python
        
            api = wikipediaapi.Wikipedia(
                language='en',
                proxies={'http': 'http://localhost:1234'}
            )
        
        * Extends documentation
        
        .. _request: http://docs.python-requests.org/en/master/api/#requests.request
        
        0.3.4
        -----
        * Adds support for `property Categorymembers`_
        * Adds property ``text`` for retrieving complete text of the page
        
        .. _property Categorymembers: https://www.mediawiki.org/wiki/API:Categorymembers
        
        0.3.3
        -----
        * Added support for `request timeout`_
        * Add header: Accept-Encoding: gzip
        
        .. _request timeout: https://github.com/martin-majlis/Wikipedia-API/issues/1
        
        0.3.2
        -----
        * Added support for `property Categories`_
        
        .. _property Categories: https://www.mediawiki.org/wiki/API:Categories
        
        0.3.1
        -----
        * Removing ``WikipediaLangLink``
        * Page keeps track of its own language, so it's easier to jump between different translations of the same page
        
        0.3.0
        -----
        * Rename directory from ``wikipedia`` to ``wikipediaapi`` to avoid collisions
        
        0.2.4
        -----
        * Handle redirects properly
        
        0.2.3
        -----
        * Usage method ``page`` instead of ``article`` in ``Wikipedia``
        
        0.2.2
        -----
        * Added support for `property Links`_
        
        .. _property Links: https://www.mediawiki.org/wiki/API:Links
        
        0.2.1
        -----
        * Added support for `property Langlinks`_
        
        .. _property Langlinks: https://www.mediawiki.org/wiki/API:Langlinks
        
        0.2.0
        -----
        * Use properties instead of functions
        * Added support for `property Info`_
        
        .. _property Info: https://www.mediawiki.org/wiki/API:Info
        
        0.1.6
        -----
        * Support for extracting texts with HTML markdown
        * Added initial version of unit tests
        
        0.1.4
        -----
        * It's possible to extract summary and sections of the page
        * Added support for `property Extracts`_
        
        .. _property Extracts: https://www.mediawiki.org/wiki/Extension:TextExtracts#API
        
Keywords: Wikipedia API wrapper
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Communications :: Email
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: testing
