Skip to content

Commit 369fb87

Browse files
committed
Update release date, added module docstrings
1 parent dd8a317 commit 369fb87

22 files changed

+27
-4
lines changed

CHANGELOG.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ Changelog
88

99
.. v5.0.0
1010
11-
5.0.0 (Unreleased)
11+
5.0.0 (2021-08-06)
1212
==================
1313
- Added parsing for Tibia Drome leaderboards, new ``Leaderboard`` class.
1414
- Auxiliary classes ``LeaderboardEntry`` and ``LeaderboardRotation`` were added as well.
1515
- New ``Client`` method: ``fetch_leaderboards``.
16-
- Added parsing for Spells library, new ``SpellsSection class.
16+
- Added parsing for Spells library, new ``SpellsSection`` class.
1717
- Auxiliary classes ``Spell`` and ``SpellEntry``.
1818
- New ``Client`` methods: ``fetch_spell`` and ``fetch_spells``
1919
- Fix last page of highscores having ``0`` as page value.

docs/api.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -800,7 +800,6 @@ Exceptions
800800

801801
Utility functions
802802
==================
803-
These are functions used thorough the module that may not be intended for public use.
804803

805804
.. automodule:: tibiapy.utils
806805
:members:

tibiapy/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
"""Tibia.com parsing and fetching library."""
12
__version__ = '5.0.0'
23
__author__ = 'Allan Galarza'
4+
__license__ = 'Apache-2.0 License'
35

46
import logging
57

tibiapy/abc.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""Base classes shared by various models."""
12
from __future__ import annotations
23

34
import abc

tibiapy/bazaar.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""Contains all classes related to the Character Bazaar sections in Tibia.com"""
12
import datetime
23
import logging
34
import re

tibiapy/character.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""Models related to the Tibia.com character page."""
12
import datetime
23
import re
34
import urllib.parse

tibiapy/client.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""Asynchronous Tibia.com client."""
12
import asyncio
23
import datetime
34
import json

tibiapy/creature.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""Models related to the creatures section in the library."""
12
import re
23
import urllib.parse
34
from typing import List, Optional

tibiapy/enums.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""Enumerations used by models throughout the library."""
12
import enum
23

34
__all__ = (

tibiapy/errors.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
"""Exceptions thrown by tibia.py."""
2+
3+
14
class TibiapyException(Exception):
25
"""Base exception for the tibiapy module.
36

0 commit comments

Comments
 (0)