Merge pull request #24 from Galarzaa90/dev

v3.0.0

Author: Galarzaa90

.github/workflows/pythonpackage.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.5, 3.6, 3.7]
+        python-version: [3.6, 3.7]
 
     steps:
     - uses: actions/checkout@v1

.travis.yml

@@ -1,10 +1,9 @@
 language: python
 
 python:
-  - "3.5"
   - "3.6"
-  - "3.7-dev"
-  - "pypy3.5"
+  - "3.7"
+  - "3.8"
 
 cache: pip
 
@@ -34,7 +33,7 @@ after_script:
   - if [[ "$TRAVIS_PYTHON_VERSION" == "3.6" ]]; then codecov; fi
 
 deploy:
-  provider: pages
+  provider: pagestotal_pages
   skip_cleanup: true
   github-token: $GITHUB_TOKEN
   local-dir: docs/_build/html

CHANGELOG.rst

@@ -6,6 +6,35 @@ Changelog
     Due to this library relying on external content, older versions are not guaranteed to work.
     Try to always use the latest version.
 
+.. v3.0.0:
+
+3.0.0 (2020-07-13)
+==================
+- The ``Client`` class' methods now return their responses wrapped in a ``TibiaResponse`` object.
+  This contains information about Tibia.com's cache.
+- Added parsing for Guild wars.
+    - Added class ``GuildWars``
+    - Added class ``GuildWarsEntry``
+    - Added ``url_wars`` property and ``get_url_wars`` class method to all Guild classes.
+    - Added ``active_war`` attribute to ``Guild``.
+- Added parsing for the Tibia forums: Boards, Threads, Posts, Announcements
+    - Added classes ``ForumBoard`` and ``ListedBoard``
+    - Added classes ``ForumThread`` and ``ListedThread``
+    - Added classes ``ForumAnnouncement`` and ``ListedAnnouncement``
+    - Added classes ``ForumPost``
+    - Added auxiliary classes ``LastPost``,  ``ForumAuthor`` and ``ThreadStatus``.
+    - Added property ``thread_url`` to ``News``.
+- Updated highscores for Summer Update 2020:
+    - ``page`` and ``total_pages`` are now fields instead of properties.
+    - Added ``last_updated`` field.
+    - Added ``Category.GOSHNARS_TAINT`` and ``Category.CHARM_POINTS``.
+    - Added ``VocationFilter.NONE``.
+- Removed deprecated property ``house`` from ``Character``, use ``houses`` instead.
+- Removed support for Python 3.5.
+- Changed the hierarchy of base classes. Base classes no longer implement ``Serializable``, ``Serializable`` is now
+  directly implemented by most classes.
+- Removed TibiaData functionality.
+
 .. _v2.5.1:
 
 2.5.1 (2020-05-27)

docs/api.rst

@@ -14,6 +14,9 @@ Client
 .. autoclass:: Client
     :members:
 
+.. autoclass:: TibiaResponse
+    :members:
+
 Enumerations
 ============
 Enumerations are provided for various values in order to avoid depending on strings.
@@ -55,6 +58,10 @@ Enumerations are provided for various values in order to avoid depending on stri
     :members:
     :undoc-members:
 
+.. autoclass:: ThreadStatus
+    :members:
+    :undoc-members:
+
 .. autoclass:: TournamentWorldType
     :members:
     :undoc-members:
@@ -75,8 +82,6 @@ Enumerations are provided for various values in order to avoid depending on stri
     :members:
     :undoc-members:
 
-    .. automethod:: VocationFilter.from_name
-
 .. autoclass:: WorldLocation
     :members:
     :undoc-members:
@@ -98,12 +103,48 @@ Character
    :members:
    :inherited-members:
 
+CMPostArchive
+-------------
+.. autoclass:: CMPostArchive
+   :members:
+   :inherited-members:
+
+EventSchedule
+-------------
+.. autoclass:: EventSchedule
+   :members:
+   :inherited-members:
+
+ForumAnnouncement
+-----------------
+.. autoclass:: ForumAnnouncement
+    :members:
+    :inherited-members:
+
+ForumBoard
+----------
+.. autoclass:: ForumBoard
+    :members:
+    :inherited-members:
+
+ForumThread
+-----------
+.. autoclass:: ForumThread
+    :members:
+    :inherited-members:
+
 Guild
 -----
 .. autoclass:: Guild
    :members:
    :inherited-members:
 
+GuildWars
+---------
+.. autoclass:: GuildWars
+   :members:
+   :inherited-members:
+
 Highscores
 ----------
 .. autoclass:: Highscores
@@ -122,6 +163,18 @@ KillStatistics
    :members:
    :inherited-members:
 
+ListedAnnouncement
+------------------
+.. autoclass:: ListedAnnouncement
+    :members:
+    :inherited-members:
+
+ListedBoard
+-----------
+.. autoclass:: ListedBoard
+    :members:
+    :inherited-members:
+
 ListedGuild
 -----------
 .. autoclass:: ListedGuild
@@ -140,6 +193,12 @@ ListedNews
    :members:
    :inherited-members:
 
+ListedThread
+------------
+.. autoclass:: ListedThread
+    :members:
+    :inherited-members:
+
 ListedTournament
 -----------------------
 .. autoclass:: ListedTournament
@@ -211,12 +270,36 @@ CharacterHouse
    :members:
    :inherited-members:
 
+CMPost
+------
+.. autoclass:: CMPost
+   :members:
+   :inherited-members:
+
+EventEntry
+-------------
+.. autoclass:: EventEntry
+   :members:
+   :inherited-members:
+
 ExpHighscoresEntry
--------------------------
+------------------
 .. autoclass:: ExpHighscoresEntry
    :members:
    :inherited-members:
 
+ForumAuthor
+-----------
+.. autoclass:: ForumAuthor
+    :members:
+    :inherited-members:
+
+ForumEmoticon
+-------------
+.. autoclass:: ForumEmoticon
+    :members:
+    :inherited-members:
+
 Death
 -----
 .. autoclass:: Death
@@ -247,6 +330,11 @@ GuildMembership
    :members:
    :inherited-members:
 
+GuildWarEntry
+-------------
+.. autoclass:: GuildWarEntry
+   :members:
+   :inherited-members:
 
 HighscoresEntry
 ---------------
@@ -260,6 +348,12 @@ Killer
    :members:
    :inherited-members:
 
+LastPost
+--------
+.. autoclass:: LastPost
+    :members:
+    :inherited-members:
+
 LeaderboardEntry
 ----------------
 .. autoclass:: LeaderboardEntry
@@ -314,6 +408,15 @@ The following classes are not meant to be used or instantiated, but are document
 
 They implement methods and properties that can be inherited by other classes to implement their functionality.
 
+
+.. autoclass:: tibiapy.abc.BaseAnnouncement
+    :members:
+    :inherited-members:
+
+.. autoclass:: tibiapy.abc.BaseBoard
+    :members:
+    :inherited-members:
+
 .. autoclass:: tibiapy.abc.BaseCharacter
     :members:
     :inherited-members:
@@ -326,14 +429,22 @@ They implement methods and properties that can be inherited by other classes to
     :members:
     :inherited-members:
 
-.. autoclass:: tibiapy.abc.BaseHouseWithId
+.. autoclass:: tibiapy.abc.HouseWithId
     :members:
     :inherited-members:
 
 .. autoclass:: tibiapy.abc.BaseNews
     :members:
     :inherited-members:
 
+.. autoclass:: tibiapy.abc.BasePost
+    :members:
+    :inherited-members:
+
+.. autoclass:: tibiapy.abc.BaseThread
+    :members:
+    :inherited-members:
+
 .. autoclass:: tibiapy.abc.BaseTournament
     :members:
     :inherited-members:

docs/conf.py

@@ -11,8 +11,8 @@
 
 
 def setup(app):
-    app.add_stylesheet('custom.css')
-    app.add_javascript('custom.js')
+    app.add_css_file('custom.css')
+    app.add_js_file('custom.js')
 
 # -- Path setup --------------------------------------------------------------
 
@@ -29,7 +29,7 @@ def setup(app):
 # -- Project information -----------------------------------------------------
 
 project = 'Tibia.py'
-copyright = '2018, Allan Galarza'
+copyright = '2020, Allan Galarza'
 author = 'Allan Galarza'
 
 # The short X.Y version
@@ -56,8 +56,7 @@ def setup(app):
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
     'sphinx.ext.napoleon',
-    'sphinx.ext.coverage',
-    'sphinxcontrib.asyncio'
+    'sphinx.ext.coverage'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -196,5 +195,5 @@ def setup(app):
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     'https://docs.python.org/': None,
-    'aiohttp': ('https://aiohttp.readthedocs.io/en/stable/', None)
+    'aiohttp': ('https://aiohttp.readthedocs.io/en/stable/', None),
 }

docs/index.rst

@@ -9,7 +9,6 @@ Tibia.py
 
 
 Tibia.py is a library for parsing HTML content from Tibia.com_. into Python objects.
-It can also parse json content from TibiaData_.
 
 **Features:**
 
@@ -22,7 +21,6 @@ It can also parse json content from TibiaData_.
 
 
 .. _Tibia.com: https://www.tibia.com/news/?subtopic=latestnews
-.. _TibiaData: https://www.tibiadata.com/
 .. _aiohttp: https://aiohttp.readthedocs.io/en/stable/
 
 

docs/intro.rst

@@ -6,7 +6,7 @@ Introduction
 
 Prerequisites
 =============
-Tibia.py requires Python 3.5 or higher.
+Tibia.py requires Python 3.6 or higher.
 Dependencies are installed automatically when installing the package.
 
 However, since it uses ``lxml`` for parsing, on Linux you may require to install libxml on your system.
@@ -39,8 +39,8 @@ The asynchronous client (:class:`tibiapy.Client`) contains methods to obtain inf
 
 The parsing methods allow you to get Python objects given the html content of a page.
 
-The main models have a ``get_url``/``get_url_tibiadata`` method that can be used to get their Tibia.com/TibiaData.com page.
-With the url, the html/json content can be fetched and then passed to their ``from_content``/``from_tibiadata`` methods.
+The main models have a ``get_url`` method that can be used to get their Tibia.com page.
+With the url, the html/json content can be fetched and then passed to their ``from_content`` methods.
 
 This allows you to use any networking module to obtain the data, and use the library to parse it.
 
@@ -67,10 +67,29 @@ Supported Sections
 +============================+============================================+=============================================+
 | Characters_                | :meth:`Character.from_content`             | :meth:`Client.fetch_character`              |
 +----------------------------+--------------------------------------------+---------------------------------------------+
+| `CM Post Archive`_         | :meth:`CMPostArchive.from_content`         | :meth:`Client.fetch_cm_post_archive`        |
++----------------------------+--------------------------------------------+---------------------------------------------+
+| `Event Schedule`_          | :meth:`EventSchedule.from_content`         | :meth:`Client.fetch_event_schedule`         |
++----------------------------+--------------------------------------------+---------------------------------------------+
 | Guilds_ (Individual)       | :meth:`Guild.from_content`                 | :meth:`Client.fetch_guild`                  |
 +----------------------------+--------------------------------------------+---------------------------------------------+
 | Guilds_ (List)             | :meth:`ListedGuild.list_from_content`      | :meth:`Client.fetch_world_guilds`           |
 +----------------------------+--------------------------------------------+---------------------------------------------+
+| Guilds_ (Wars)             | :meth:`GuildWars.from_content`             | :meth:`Client.fetch_guild_wars`             |
++----------------------------+--------------------------------------------+---------------------------------------------+
+| Forums_ (Section)          | :meth:`ListedBoard.list_from_content`      | :meth:`Client.fetch_forum_world_boards`     |
+|                            |                                            | :meth:`Client.fetch_forum_trade_boards`     |
+|                            |                                            | :meth:`Client.fetch_forum_community_boards` |
+|                            |                                            | :meth:`Client.fetch_forum_support_boards`   |
++----------------------------+--------------------------------------------+---------------------------------------------+
+| Forums_ (Board)            | :meth:`ForumBoard.from_content`            | :meth:`Client.fetch_forum_board`            |
++----------------------------+--------------------------------------------+---------------------------------------------+
+| Forums_ (Announcement)     | :meth:`ForumAnnouncement.from_content`     | :meth:`Client.fetch_forum_announcement`     |
++----------------------------+--------------------------------------------+---------------------------------------------+
+| Forums_ (Thread)           | :meth:`ForumThread.from_content`           | :meth:`Client.fetch_forum_thread`           |
++----------------------------+--------------------------------------------+---------------------------------------------+
+| Highscores_                | :meth:`Highscores.from_content`            | :meth:`Client.fetch_highscores_page`        |
++----------------------------+--------------------------------------------+---------------------------------------------+
 | Highscores_                | :meth:`Highscores.from_content`            | :meth:`Client.fetch_highscores_page`        |
 +----------------------------+--------------------------------------------+---------------------------------------------+
 | Houses_ (Individual)       | :meth:`House.from_content`                 | :meth:`Client.fetch_house`                  |
@@ -95,7 +114,10 @@ Supported Sections
 
 
 .. _Characters: https://www.tibia.com/community/?subtopic=characters
+.. _CM Post Archive: https://www.tibia.com/forum/?subtopic=forum&action=cm_post_archive
+.. _Event Schedule: https://www.tibia.com/news/?subtopic=eventcalendar
 .. _Guilds: https://www.tibia.com/community/?subtopic=guilds
+.. _Forums: https://www.tibia.com/community/?subtopic=forum
 .. _Highscores: https://www.tibia.com/community/?subtopic=highscores
 .. _Houses: https://www.tibia.com/community/?subtopic=houses
 .. _Kill Statistics: https://www.tibia.com/community/?subtopic=killstatistics