Metadata-Version: 2.4
Name: pageviewapi
Version: 0.5.0
Summary: Wikimedia Pageview API client
Project-URL: Homepage, https://github.com/Commonists/pageview-api
Author-email: Commonists <ps.huard@gmail.com>
License: MIT
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: requests>=2.0
Description-Content-Type: text/markdown

# pageview-api
[![CI](https://github.com/Commonists/pageview-api/actions/workflows/ci.yml/badge.svg)](https://github.com/Commonists/pageview-api/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/Commonists/pageview-api/branch/master/graph/badge.svg)](https://codecov.io/gh/Commonists/pageview-api)
[![Pypi](https://img.shields.io/pypi/v/pageviewapi.svg?style=flat)](https://pypi.python.org/pypi/pageviewapi)
[![License](http://img.shields.io/badge/license-MIT-orange.svg?style=flat)](http://opensource.org/licenses/MIT)

Wikimedia Pageview API client for Python 3.10+

Installation
------------
In order to install system wide on system using sudo you can use:
```sh
pip install git+https://github.com/Commonists/pageview-api.git
```

Examples
--------

Number of view on English Wikipedia of article Paris from November 6th to November 20th 2015

```python
import pageviewapi
pageviewapi.per_article('en.wikipedia', 'Paris', '20151106', '20151120',
                        access='all-access', agent='all-agents', granularity='daily')
```

Aggregation: Get a daily pageview count timeseries of all projects for the month of October 2015
```python
import pageviewapi
pageviewapi.aggregate('fr.wikipedia', '2015100100', '2015103100', access='all-access',
                      agent='all-agents', granularity='daily')
```

Most viewed articles on French Wikipedia on November 14th, 2015
```python
import pageviewapi
pageviewapi.top('fr.wikipedia', 2015, 11, 14, access='all-access')
```

Sum (resp. average) of view during last 30 days
```python
import pageviewapi.period
pageviewapi.period.sum_last('fr.wikipedia', 'Paris', last=30,
                            access='all-access', agent='all-agents')

pageviewapi.period.avg_last('fr.wikipedia', 'Paris', last=30)
```

Monthly legacy pagecounts (2008 until end of 2016) on a project
```python
import pageviewapi
pageviewapi.legacy_pagecounts('fr.wikipedia', '2010010100', '2011010100', granularity='monthly')
```
