Merge pull request #28 from ClementJ18/develop

v0.8.1 release

Author: ClementJ18

.gitignore

@@ -5,3 +5,4 @@ moddb.log
 tests/test_config.py
 tests/fixtures/
 report.html
+moddb.egg-info/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Clement
+Copyright (c) 2022 Clement
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/source/changelog.rst

@@ -8,6 +8,33 @@ The page attempt to keep a clear list of breaking/non-breaking changes and new f
    :local:
    :backlinks: none
 
+v0.8.1
+-------
+Bug Fixes
+##########
+* Relaxed regex on `File.get_mirrors` to avoid failing in certain edge cases
+
+New Features
+#############
+* Increased ratelimit to 1/2.5sec, 60/5min
+* New objects :class:`Thread`, :class:`Message` and :class:`ThreadThumbnail`
+
+New :class:`.Client` methods
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+For sending and manipulating messages:
+* :func:`Client.get_threads`
+* :func:`Client.parse_thread`
+* :func:`Client.send_message`
+* :func:`Client.reply_to_thread`
+* :func:`Client.add_member_to_thread`
+* :func:`Client.leave_thread`
+* :func:`Client.mark_all_read`
+* :func:`Client.clear_watched`
+
+Removed Features
+#################
+
+
 v0.8.0
 -------
 Bug Fixes

docs/source/client.rst

@@ -12,6 +12,28 @@ Client
     :members:
     :inherited-members:
 
+
+ThreadThumbnail
+----------------
+.. autoclass:: moddb.client.ThreadThumbnail
+    :members:
+    :inherited-members:
+
+
+Thread
+----------------
+.. autoclass:: moddb.client.Thread
+    :members:
+    :inherited-members:
+
+
+Message
+----------------
+.. autoclass:: moddb.client.Message
+    :members:
+    :inherited-members:
+
+
 Update
 -----------
 .. autoclass:: moddb.client.Update

docs/source/conf.py

@@ -27,7 +27,7 @@
 # The short X.Y version
 version = ""
 # The full version, including alpha/beta/rc tags
-release = "0.8.0"
+release = "0.8.1"
 
 
 # -- General configuration ---------------------------------------------------

moddb/__init__.py

@@ -2,10 +2,10 @@
 from .utils import LOGGER, BASE_URL, soup, request, get_page, Object
 from .enums import *
 from .pages import *
-from .client import Client
+from .client import Client, Thread
 
 import requests
 
 SESSION = requests.Session()
 
-__version__ = "0.8.0"
+__version__ = "0.8.1"

moddb/boxes.py

@@ -1204,11 +1204,11 @@ class Mirror:
         The index of the mirror, as multiple mirrors
         have the same name. Index starts at 1
     city : str
-        Alpha 2 code for the city the server is located
-        in
+        Alpha 2 code, or full name, of the city the server is located
+        in. Sometimes represents a country.
     country : str
         Alpha 2 code for the country the server is
-        located in
+        located in. Sometimes represents a continent.
     served : int
         How many downloads of this file this mirror has
         served