Added changelog to documentation

- Added type hints to many instance variables

Author: Galarzaa90

CHANGELOG.md

@@ -0,0 +1,40 @@
+=========
+Changelog
+=========
+
+.. _v1.1.0:
+
+1.1.0 (2019-01-08)
+==================
+
+- Parsing Highscores from Tibia.com and TibiaData.
+- Some strings from TibiaData had unpredictable trailing whitespaces,
+  all leading and trailing whitespaces are removed.
+- Added type hints to many variables and methods.
+
+.. _v1.0.0:
+
+1.0.0 (2018-12-23)
+==================
+
+-  Added support for TibiaData JSON parsing. To have interoperability
+   between Tibia.com and TibiaData.
+-  Added support for parsing Houses, House lists, World and World list
+-  Added support for many missing attributes in Character and Guilds.
+-  All objects are now serializable to JSON strings.
+
+.. _v0.1.0:
+
+0.1.0 (2018-08-17)
+==================
+
+Initial release:
+
+-  Parses content from tibia.com
+
+   -  Character pages
+   -  Guild pages
+   -  Guild list pages
+
+-  Parses content into JSON format strings.
+-  Parses content into Python objects.

CHANGELOG.rst

@@ -1,4 +1,4 @@
 include requirements.txt
 include README.md
-include CHANGELOG.md
+include CHANGELOG.rst
 include LICENSE

MANIFEST.in

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

docs/changelog.rst

@@ -100,7 +100,8 @@ def setup(app):
     'github_repo': 'tibia.py',
     'github_type': 'star',
     'fixed_sidebar': True,
-    'travis_button': True
+    'travis_button': True,
+    'donate_url': 'https://beerpay.io/Galarzaa90/tibia.py'
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/conf.py

@@ -32,6 +32,7 @@ Indices and tables
 
    intro
    api
+   changelog
 
 * :ref:`genindex`
 * :ref:`search`

docs/index.rst

@@ -14,6 +14,24 @@ def get_version(package):
     return re.search("__version__ = ['\"]([^'\"]+)['\"]", init_py).group(1)
 
 
+version = get_version("tibiapy")
+if version.endswith(('a', 'b', 'rc')):
+    # append version identifier based on commit count
+    try:
+        import subprocess
+        p = subprocess.Popen(['git', 'rev-list', '--count', 'HEAD'],
+                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        out, err = p.communicate()
+        if out:
+            version += out.decode('utf-8').strip()
+        p = subprocess.Popen(['git', 'rev-parse', '--short', 'HEAD'],
+                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        out, err = p.communicate()
+        if out:
+            version += '+g' + out.decode('utf-8').strip()
+    except Exception:
+        pass
+
 with open('requirements.txt') as f:
     requirements = f.read().splitlines()
 
@@ -33,7 +51,7 @@ def get_version(package):
 
 setup(
     name='tibia.py',
-    version=get_version("tibiapy"),
+    version=version,
     author='Galarzaa90',
     author_email="allan.galarza@gmail.com",
     url='https://github.com/Galarzaa90/tibia.py',

setup.py

@@ -54,6 +54,17 @@ exist.
 - [tibiadata_list.json](house/tibiadata_list.json) - A house list on TibiaData.
 - [tibiadata_list_not_found.json](house/tibiadata_list_not_found.json) - The TibiaData response for a house list that
 doesn't exist.
+
+## Highscores resources
+- [tibiacom_full.txt](highscores/tibiacom_full.txt) - The content of a correct highscore's pagem
+- [tibiacom_empty.txt](highscores/tibiacom_empty.txt) - The content of the highscores page of a nonexistent world.
+- [tibiacom_experience.txt](highscores/tibiacom_experience.txt) - The content of an experience highscores page.
+- [tibiacom_loyalty.txt](highscores/tibiacom_loyalty.txt) - The content of a loyalty highscores page.
+- [tibiadata_full.json](highscores/tibiadata_full.json) - A highscores response from TibiaData.
+- [tibiadata_empty.json](highscores/tibiadata_empty.json) - A highscores response from TibiaData of a nonexistent world.
+- [tibiadata_experience.json](highscores/tibiadata_experience.json) - A response containing experience highscores from
+TibiaData.
+- [tibiadata_loyalty.json](highscores/tibiadata_loyalty.json) - A response containing loyalty highscores from TibiaData.
 
  ## World resources
  - [tibiacom_online.txt](world/tibiacom_online.txt) - An online world on Tibia.com.

tests/resources/README.md

@@ -7,4 +7,4 @@
 from tibiapy.house import *
 from tibiapy.world import *
 
-__version__ = '1.0.0'
+__version__ = '1.1.0rc'

tibiapy/__init__.py

@@ -48,9 +48,9 @@ class AccountInformation(abc.Serializable):
     __slots__ = ("created", "loyalty_title", "position")
 
     def __init__(self, created, loyalty_title=None, position=None):
-        self.created = created
-        self.loyalty_title = loyalty_title
-        self.position = position
+        self.created = try_datetime(created)
+        self.loyalty_title = loyalty_title  # type: Optional[str]
+        self.position = position  # type: Optional[str]
 
     def __repr__(self):
         return "<%s created=%r>" % (self.__class__.__name__, self.created)
@@ -69,8 +69,8 @@ class Achievement(abc.Serializable):
     __slots__ = ("name", "grade")
 
     def __init__(self, name, grade):
-        self.name = name
-        self.grade = grade
+        self.name = name   # type: str
+        self.grade = int(grade)
 
     def __repr__(self):
         return "<%s name=%r grade=%d>" % (self.__class__.__name__, self.name, self.grade)
@@ -134,8 +134,8 @@ def __init__(self, name=None, world=None, vocation=None, level=0, sex=None, **kw
         self.former_names = kwargs.get("former_names", [])  # type: List[str]
         self.sex = try_enum(Sex, sex)
         self.vocation = try_enum(Vocation, vocation)
-        self.level = level  # type: int
-        self.achievement_points = kwargs.get("achievement_points", 0)  # type: int
+        self.level = int(level)
+        self.achievement_points = int(kwargs.get("achievement_points", 0))
         self.world = world  # type: str
         self.former_world = kwargs.get("former_world")  # type: Optional[str]
         self.residence = kwargs.get("residence")  # type: str
@@ -622,8 +622,8 @@ class GuildMembership(abc.BaseGuild):
     __slots__ = ("rank",)
 
     def __init__(self, name, rank):
-        self.name = name
-        self.rank = rank
+        self.name = name  # type: str
+        self.rank = rank  # type: str
 
     def __repr__(self):
         return "<{0.__class__.__name__} name={0.name!r} rank={0.rank!r}>".format(self)
@@ -651,9 +651,9 @@ class Killer(abc.Serializable):
     __slots__ = ("name", "player", "summon")
 
     def __init__(self, name, player=False, summon=None):
-        self.name = name
-        self.player = player
-        self.summon = summon
+        self.name = name  # type: str
+        self.player = player  # type: bool
+        self.summon = summon  # type: Optional[str]
 
     def __repr__(self):
         attributes = ""
@@ -695,11 +695,11 @@ class OtherCharacter(abc.BaseCharacter):
     """
     __slots__ = ("world", "online", "deleted")
 
-    def __init__(self, name, world=None, online=False, deleted=False):
-        self.name = name
-        self.world = world
-        self.online = online
-        self.deleted = deleted
+    def __init__(self, name, world, online=False, deleted=False):
+        self.name = name  # type: str
+        self.world = world  # type: str
+        self.online = online  # type: bool
+        self.deleted = deleted  # type: bool
 
 
 class OnlineCharacter(abc.BaseCharacter):
@@ -719,7 +719,7 @@ class OnlineCharacter(abc.BaseCharacter):
     __slots__ = ("world", "vocation", "level")
 
     def __init__(self, name, world, level, vocation):
-        self.name = name
-        self.world = world
+        self.name = name  # type: str
+        self.world = world  # type: str
         self.level = int(level)
         self.vocation = try_enum(Vocation, vocation)