Documentation improvements

Author: Galarzaa90

Dockerfile

@@ -1,9 +1,21 @@
 FROM python:3.9-slim
-
+RUN apt-get update \
+    && apt-get install gcc -y \
+    && apt-get clean
 WORKDIR /app
 COPY requirements.txt .
 RUN pip install -r requirements.txt uvloop
 
+LABEL maintainer="Allan Galarza <[email protected]>"
+LABEL org.opencontainers.image.licenses="Apache 2.0"
+LABEL org.opencontainers.image.authors="Allan Galarza <[email protected]>"
+LABEL org.opencontainers.image.url="https://github.com/Galarzaa90/tibia.py"
+LABEL org.opencontainers.image.source="https://github.com/Galarzaa90/tibia.py"
+LABEL org.opencontainers.image.vendor="Allan Galarza <[email protected]>"
+LABEL org.opencontainers.image.title="tibia.py"
+LABEL org.opencontainers.image.description="API that parses website content into python data."
+
+
 COPY . .
 RUN python setup.py install
 EXPOSE 8000

cli.py

@@ -359,14 +359,21 @@ async def middleware_handler(request: web.Request):
 async def init_client(app):
     app["tibiapy"] = tibiapy.Client()
 
+
+async def cleanup_client(app):
+    await app["tibiapy"].session.close()
+
+
 if __name__ == "__main__":
     normalize_paths = normalize_path_middleware(remove_slash=True, append_slash=False)
     app = web.Application(middlewares=[
         error_middleware,
-        normalize_paths])
+        normalize_paths,
+    ])
     app.add_routes(routes)
     app.on_startup.append(init_client)
+    app.on_cleanup.append(cleanup_client)
     print("Registered routes:")
     for route in routes:  # type: RouteDef
-        print('\t[%s] %s' % (route.method, route.path))
+        print('- %s %s' % (route.method, route.path))
     web.run_app(app, port=8000)

serve.py

@@ -39,18 +39,13 @@ def get_version(package):
     readme = f.read()
 
 extras_require = {
-    'cli': [
-        'click',
-        'requests',
-        'colorama'
-    ],
     'docs': [
         'sphinx',
     ],
     'test': [
         'asynctest',
         'aioresponses',
-        'coverage'
+        'coverage',
     ]
 }
 
@@ -68,6 +63,15 @@ def get_version(package):
     long_description_content_type="text/markdown",
     packages=find_packages(),
     include_package_data=True,
+    project_urls={
+        "GitHub: Repo": "https://github.com/Galarzaa90/tibia.py",
+        "GitHub: Issues": "https://github.com/Galarzaa90/tibia.py/issues",
+        "Docs: RTD": "https://tibiapy.readthedocs.io/en/stable/",
+        "Docs: Changelog": "https://tibiapy.readthedocs.io/en/stable/changelog.html",
+        "Coverage: Codecov": "https://app.codecov.io/gh/Galarzaa90/tibia.py",
+        "Docker Hub: Repo": "https://hub.docker.com/repository/docker/galarzaa90/tibia.py",
+        "SonarCloud": "https://sonarcloud.io/dashboard?id=Galarzaa90_tibia.py",
+    },
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
@@ -86,6 +90,6 @@ def get_version(package):
         'Topic :: Software Development :: Libraries',
         'Topic :: Text Processing :: Markup :: HTML',
         'Topic :: Utilities',
-        'Typing :: Typed'
+        'Typing :: Typed',
     ]
 )

setup.py

@@ -1,4 +1,4 @@
-__version__ = '3.7.1'
+__version__ = '4.0.0'
 __author__ = 'Allan Galarza'
 
 import logging

tibiapy/__init__.py

@@ -1133,7 +1133,7 @@ def _parse_data_table(cls, table) -> Dict[str, str]:
             data[name] = value
         return data
 
-    def parse_skills_table(self, table):
+    def _parse_skills_table(self, table):
         """Parses the skills table.
 
         Parameters
@@ -1248,7 +1248,7 @@ def _parse_bestiary_table(self, table):
             self.bestiary_progress.append(BestiaryEntry(name_c, kills, step))
 
     @classmethod
-    def parse_page_items(cls, content, entry_class):
+    def _parse_page_items(cls, content, entry_class):
         """Parses the elements of a page in the items, mounts and outfits.
 
         Attributes
@@ -1260,7 +1260,6 @@ def parse_page_items(cls, content, entry_class):
 
         Returns
         -------
-        -
             The entries contained in the page.
         """
         parsed_content = parse_tibiacom_content(content, builder='html5lib')
@@ -1291,7 +1290,7 @@ def _parse_general_table(self, table):
         self.titles_count = parse_integer(general_stats.get("titles", "0"))
         self.blessings_count = parse_integer(re.sub(r"/d+", "", general_stats.get("blessings", "0")))
 
-        self.parse_skills_table(content_containers[1])
+        self._parse_skills_table(content_containers[1])
 
         additional_stats = self._parse_data_table(content_containers[2])
         self.creation_date = parse_tibia_datetime(additional_stats.get("creation_date", "").replace("\xa0", " "))

tibiapy/bazaar.py

@@ -187,9 +187,9 @@ async def _request(self, method, url, data=None, headers=None):
             async with self.session.request(method, url, data=data, headers=headers) as resp:
                 diff_time = time.perf_counter()-init_time
                 if "maintenance.tibia.com" in str(resp.url):
-                    log.info(f"%s | %s | %s %s | maintenance.tibia.com", url, method, resp.status, resp.reason)
+                    log.info(f"%s | %s | %s %s | maintenance.tibia.com", url, resp.method, resp.status, resp.reason)
                     raise SiteMaintenanceError("Tibia.com is down for maintenance.")
-                log.info(f"%s | %s | %s %s | %dms", url, method, resp.status, resp.reason, int(diff_time*1000))
+                log.info(f"%s | %s | %s %s | %dms", url, resp.method, resp.status, resp.reason, int(diff_time*1000))
                 self._handle_status(resp.status)
                 response = RawResponse(resp, diff_time)
                 response.content = await resp.text()
@@ -337,7 +337,7 @@ async def _fetch_all_pages(self, auction_id, paginator, item_type):
         current_page = 2
         while current_page <= paginator.total_pages:
             content = await self._fetch_ajax_page(auction_id, item_type, current_page)
-            entries = AuctionDetails.parse_page_items(content, paginator.entry_class)
+            entries = AuctionDetails._parse_page_items(content, paginator.entry_class)
             paginator.entries.extend(entries)
             current_page += 1
         paginator.fully_fetched = True
@@ -668,6 +668,8 @@ async def fetch_boosted_creature(self):
         """Fetches today's boosted creature.
 
         .. versionadded:: 2.1.0
+        .. versionchanged:: 4.0.0
+            The return type of the data returned was changed to :class:`Creature`, previous type was removed.
 
         Returns
         -------
@@ -1096,7 +1098,7 @@ async def fetch_news_archive(self, begin_date, end_date, categories=None, types=
         if NewsType.NEWS_TICKER in types:
             data["filter_ticker"] = "ticker"
 
-        response = await self._request("post", News.get_list_url(), data)
+        response = await self._request("POST", News.get_list_url(), data)
         start_time = time.perf_counter()
         news = ListedNews.list_from_content(response.content)
         parsing_time = time.perf_counter() - start_time

tibiapy/client.py

@@ -110,7 +110,10 @@ class AuctionStatus(BaseEnum):
 
 
 class BattlEyeType(NumericEnum):
-    """The possible BattlEye statuses a world can have."""
+    """The possible BattlEye statuses a world can have.
+
+    .. versionadded:: 4.0.0
+    """
     UNPROTECTED = 0
     """Worlds without any BattlEye protection."""
     PROTECTED = 1
@@ -132,9 +135,15 @@ class BattlEyeHighscoresFilter(NumericEnum):
     UNPROTECTED = 0
     """Worlds without any BattlEye protection."""
     YELLOW = PROTECTED
-    """Alias for protected worlds."""
+    """Alias for protected worlds.
+    
+    .. versionadded:: 4.0.0
+    """
     GREEN = INITIALLY_PROTECTED
-    """Alias for initially protected worlds."""
+    """Alias for initially protected worlds.
+    
+    .. versionadded:: 4.0.0
+    """
 
 
 class BattlEyeTypeFilter(NumericEnum):
@@ -146,9 +155,15 @@ class BattlEyeTypeFilter(NumericEnum):
     NOT_PROTECTED = 3
     """Worlds without any BattlEye protection."""
     YELLOW = PROTECTED
-    """Alias for protected worlds."""
+    """Alias for protected worlds.
+    
+    .. versionadded:: 4.0.0
+    """
     GREEN = INITIALLY_PROTECTED
-    """Alias for initially protected worlds."""
+    """Alias for initially protected worlds.
+    
+    .. versionadded:: 4.0.0
+    """
 
 
 class BazaarType(BaseEnum):

tibiapy/enums.py

@@ -446,6 +446,8 @@ class ForumAuthor(abc.BaseCharacter, abc.Serializable):
         Whether the author is deleted or not.
     traded: :class:`bool`
         Whether the author is traded or not.
+
+        .. versionadded:: 4.0.0
     """
 
     __slots__ = (

tibiapy/forum.py

@@ -52,7 +52,7 @@ def get_tibia_url(section, subtopic=None, *args, anchor=None, **kwargs):
 
     You can also build a dictionary and pass it like:
 
-    >>> params = {'world': "Gladera", }
+    >>> params = {'world': "Gladera"}
     >>> get_tibia_url("community", "worlds", **params)
     https://www.tibia.com/community/?subtopic=worlds&world=Gladera
     """
@@ -115,7 +115,7 @@ def parse_tibia_datetime(datetime_str) -> Optional[datetime.datetime]:
     Returns
     -----------
     :class:`datetime.datetime`, optional
-        The represented datetime, in UTC.
+        The represented datetime, in UTC (timezone aware).
     """
     try:
         datetime_str = datetime_str.replace(",", "").replace(" ", " ")
@@ -158,7 +158,7 @@ def parse_tibia_date(date_str) -> Optional[datetime.date]:
     Returns
     -----------
     :class:`datetime.date`, optional
-        The represented date."""
+        The represented date, in UTC (timezone aware)."""
     try:
         t = datetime.datetime.strptime(date_str.strip(), "%b %d %Y")
         return t.date()
@@ -187,7 +187,7 @@ def parse_tibia_forum_datetime(datetime_str, utc_offset=1):
     Returns
     -------
     :class:`datetime`
-        The datetime represented by the text, in UTC.
+        The represented datetime, in UTC (timezone aware).
     """
     t = datetime.datetime.strptime(datetime_str.strip(), "%d.%m.%Y %H:%M:%S")
     # Add/subtract hours to get the real time
@@ -210,7 +210,7 @@ def parse_tibia_full_date(date_str) -> Optional[datetime.date]:
     Returns
     -----------
     :class:`datetime.date`, optional
-        The represented date.
+        The represented date, in UTC (timezone aware).
     """
     try:
         t = datetime.datetime.strptime(date_str.strip(), "%B %d, %Y")
@@ -280,7 +280,7 @@ def try_datetime(obj) -> Optional[datetime.datetime]:
     Returns
     -------
     :class:`datetime.datetime`, optional
-        The represented datetime, or :obj:`None` if conversion wasn't possible.
+        The represented datetime, in UTC (timezone aware), or :obj:`None` if conversion wasn't possible.
     """
     if obj is None:
         return None
@@ -304,7 +304,7 @@ def try_date(obj) -> Optional[datetime.date]:
     Returns
     -------
     :class:`datetime.date`, optional
-        The represented date.
+        The represented date, in UTC (timezone aware).
     """
     if obj is None:
         return None
@@ -386,9 +386,8 @@ def parse_tibia_money(argument):
 
     Returns
     -------
-    int:
+    :class:`int`:
         The value represented by the string.
-
     """
     try:
         return int(argument)