wikirate4py 1.2.1

WikiRate for Python!

• Official WikiRate ‘s wrapper for Python

• Full Documentation: https://wikirate4py.readthedocs.io/

• Official Slack Channel

Installation

The easiest way to install the latest version from PyPI is by using pip:

$ pip install wikirate4py

You can also use Git to clone the repository from GitHub to install the latest development version:

$ git clone https://github.com/wikirate/wikirate4py.git
$ cd wikirate4py
$ pip install .

Alternatively, install directly from the GitHub repository:

$ pip install git+https://github.com/wikirate/wikirate4py.git

Python 3.6 - 3.9 are supported.

Usage

wikirate4py makes it trivial to interact with WikiRate’s API:

>>> from wikirate4py import API
>>> api = API('your_api_token')
>>> company = api.get_company(7217) # returns company given company's numeric identifier
>>> company.name
'Adidas AG'
>>> company.headquarters
'Germany'

DataFrames

The 1.2.0 version of wikirate4py library allows users to transform WikiRateEntity objects to DataFrames. A usage example can be found below:

from wikirate4py import API
from wikirate4py.utils import to_dataframe

api = API('your_api_token')
cursor = wikirate4py.Cursor(api.get_answers,
                            metric_name="Revenue EUR",
                            metric_designer="Clean Clothes Campaign",
                            year=2020)
answers = []
while cursor.has_next():
    answers += cursor.next()

print(to_dataframe(answers).to_string())

Contributing

Bug reports, feature suggestions requests are welcome on GitHub at https://github.com/wikirate/wikirate4py/issues.

License

The library is available as Open Source under the terms of the GNU General Public License v3 (GPLv3).