re

Author: TodoLodo

PYPI.rst

@@ -6,7 +6,10 @@ callofduty.com
 
 Devs
 ====
-[Todo Lodo](https://github.com/TodoLodo2089) and [Engineer15](https://github.com/Engineer152)
+`Todo Lodo`_ and `Engineer15`_
+
+.. _Todo Lodo: https://github.com/TodoLodo2089
+.. _Engineer15: https://github.com/Engineer152
 
 Documentation
 =============
@@ -30,10 +33,10 @@ As a python library using `pip`_:
 .. _pip: https://pip.pypa.io/en/stable/getting-started/
 
 Usage
-=====
+-----
 
 Initiation
-----------
+~~~~~~~~~~
 
 Import module with its classes:
 
@@ -51,34 +54,89 @@ Login with your sso token
     api.login('Your sso token')
 
 You sso token can be found by longing in at `callofduty`_, opening dev tools (ctr+shift+I),
-going to Applications > Storage > Cookies > https://callofduty.com, filter to search 'ACT_SSO_COOKIE' and
+going to Applications > Storage > Cookies > :samp:`https://callofduty.com`, filter to search 'ACT_SSO_COOKIE' and
 copy the value
 
 .. _callofduty: https://my.callofduty.com/
 
-Retrieving game profile
------------------------
-A player's game profile can be retrieved by using API sub game classes with its function fullData(platform, gamertag)
+Game/Other sub classes
+~~~~~~~~~~~~~~~~~~~~~~
+Following importation and initiation of the class `API` its associated subclasses can be called by `API.subClassName`
+and following are available sub classes
 
-*Example*:
+* `ColdWar`     - game
+* `ModernWarfe` - game
+* `Vanguard`    - game
+* `Warzone`     - game
+* `Me`          - other
+* `Misc`        - other
 
-.. code-block:: python
+To retrieve detailed description of each subclass `__doc__`(docstring) of each sub class can be called as shown below
 
-    from API import platforms
+.. tabs::
 
-    profileData = api.ModernWarfare.fullData(platforms.Battlenet, "Username#1234")
+    .. group-tab:: ColdWar
 
-*Output* > json
+        .. code-block:: python
 
-Retrieving combat history
--------------------------
-A player's game profile can be retrieved by using API sub game classes with its functions combatHistory(platform, gamertag) or 
-combatHistoryWithDate(platform, gamertag, start, end)
+            from cod_api import API
 
-*Example*:
+            api = API()
 
-.. code-block:: python
+            # print out the docstring
+            print(api.ColdWar)
+
+    .. group-tab:: ModernWarfare
+
+        .. code-block:: python
+
+            from cod_api import API
+
+            api = API()
+
+            # print out the docstring
+            print(api.ModernWarfare)
+
+    .. group-tab:: Vanguard
+
+        .. code-block:: python
+
+            from cod_api import API
+
+            api = API()
+
+            # print out the docstring
+            print(api.Vanguard)
+
+    .. group-tab:: Warzone
+
+        .. code-block:: python
+
+            from cod_api import API
+
+            api = API()
+
+            # print out the docstring
+            print(api.Warzone)
+
+    .. group-tab:: Me
+
+        .. code-block:: python
+
+            from cod_api import API
+
+            api = API()
+
+            # print out the docstring
+            print(api.Me)
+
+    .. group-tab:: Misc
+
+        .. code-block:: python
+
+            from cod_api import API
 
-    matchHistory = api.Warzone.combatHistory(platforms.Activision, "Username#123456")
+            api = API()
 
-*Output* > json
+            # print out the docstring
+            print(api.Misc)

README.rst

@@ -6,7 +6,10 @@ callofduty.com
 
 Devs
 ====
-[Todo Lodo](https://github.com/TodoLodo2089) and [Engineer15](https://github.com/Engineer152)
+`Todo Lodo`_ and `Engineer15`_
+
+.. _Todo Lodo: https://github.com/TodoLodo2089
+.. _Engineer15: https://github.com/Engineer152
 
 Documentation
 =============

cod_api/__init__.py

@@ -1,3 +1,3 @@
 from cod_api.cod_api import API, platforms, games, friendActions
 
-__version__ = "0.0.4dev0"
+__version__ = "0.0.5dev0"

cod_api/cod_api.py

@@ -179,7 +179,7 @@ async def fullData(self, platform:platforms, gamertag: str):
         data = await self.fullDataReq("mw", platform,  gamertag, "wz")
         return data
 
-    async def combatHistory(self, platform: platforms, gamertag: str):
+    async def combatHistory(self, platform: platforms, gamertag: str, verbose:bool=False, mapping:bool=False):
         data = await self.combatHistoryReq("mw", platform, gamertag, "wz", 0, 0)
         return data