minor updates related to v1.0.5

README.rst

@@ -45,6 +45,26 @@ wikirate4py makes it trivial to interact with WikiRate's API:
     'Germany'
 
 
+DataFrames
+----------
+
+The 1.0.5 version of wikirate4py library allows users to transform WikiRateEntity objects to DataFrames.
+A usage example can be found below:
+
+.. code-block:: python
+
+    from wikirate4py import API
+    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
 ------------
 

requirements.txt

@@ -35,3 +35,4 @@ vcrpy==4.1.1
 -e git+https://github.com/wikirate/wikirate4py.git@02de347d5ec0b02b88b912958fc2c7cf17af5efb#egg=wikirate4py
 wrapt==1.12.1
 yarl==1.6.3
+pandas=1.3.3

setup.py

@@ -28,7 +28,7 @@
       author='Vasiliki Gkatziaki',
       author_email='[email protected]',
       license='GPL-3.0',
-      download_url='https://github.com/wikirate/wikirate4py/archive/refs/tags/v1.0.4.tar.gz',
+      download_url='https://github.com/wikirate/wikirate4py/archive/refs/tags/v1.0.5.tar.gz',
       packages=find_packages(exclude=["tests", "examples"]),
       install_requires=[
           "requests",

wikirate4py/__init__.py

@@ -5,7 +5,7 @@
 """
 wikirate4py WikiRate API library
 """
-__version__ = '1.0.4'
+__version__ = '1.0.5'
 __author__ = 'Vasiliki Gkatziaki'
 __license__ = 'GPL-3.0'
 
@@ -19,3 +19,4 @@
 from wikirate4py.models import (Company, CompanyItem, Topic, TopicItem, Metric, MetricItem, ResearchGroup,
                                 ResearchGroupItem, Project, ProjectItem, CompanyGroup, CompanyGroupItem, Source,
                                 SourceItem, Answer, AnswerItem, RelationshipAnswer, RelationshipAnswerItem, Region)
+from wikirate4py.utils import to_dataframe