[FIX] docstring missing quotes

README.md

@@ -20,4 +20,4 @@ To build a wheel from the sources:
 Some examples are available [here](https://github.com/dfir-iris/iris-client/tree/master/examples).
 
 ## Documentation 
-The documentation is available in the [documentation](https://dfir-iris.github.io/python_client/modules.html#).
+The documentation is available in the [IRIS documentation](https://dfir-iris.github.io/python_client/modules/).

dfir_iris_client/admin.py

@@ -79,7 +79,7 @@ def add_user(self, login: str, name: str, password: str, email: str, is_admin: b
  - email is unique
  - password meets the requirements of IRIS
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  login: Username (login name) of the user to add
@@ -109,7 +109,7 @@ def deactivate_user(self, user_id: int = None) -> ApiResponse:
  """Deactivate a user from its user ID. Disabled users can't login interactively nor user their API keys.
  They do not appears in proposed user lists.
 
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  user_id: User ID to deactivate
@@ -133,7 +133,7 @@ def update_user(self, login: str = None,
  
  Password can be left empty to update other attributes.
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  login: Username (login name) of the user to update
@@ -171,7 +171,7 @@ def delete_user(self, login: str) -> ApiResponse:
  """Deletes a user based on its login. A user can only be deleted if it does not have any
  activities in IRIS. This is to maintain coherence in the database.
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  login: Username (login name) of the user to delete
@@ -193,7 +193,7 @@ def delete_user_by_id(self, user_id: int) -> ApiResponse:
  """Delete a user based on its ID. A user can only be deleted if it does not have any
  activities in IRIS. This is to maintain coherence in the database.
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  user_id: UserID of the user to delete
@@ -208,7 +208,7 @@ def delete_user_by_id(self, user_id: int) -> ApiResponse:
  def add_ioc_type(self, name: str, description: str, taxonomy: str = None) -> ApiResponse:
  """Add a new IOC Type.
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  name: Name of the IOC type
@@ -230,7 +230,7 @@ def add_ioc_type(self, name: str, description: str, taxonomy: str = None) -> Api
  def delete_ioc_type(self, ioc_type_id: int) -> ApiResponse:
  """Delete an existing IOC Type by its ID.
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  ioc_type_id: IOC type to delete
@@ -245,7 +245,7 @@ def update_ioc_type(self, ioc_type_id: int, name: str = None,
  description: str = None, taxonomy: str = None) -> ApiResponse:
  """Updates an IOC type. `ioc_type_id` needs to be a valid existing IocType ID.
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  ioc_type_id: IOC type to update
@@ -277,7 +277,7 @@ def update_ioc_type(self, ioc_type_id: int, name: str = None,
  def add_asset_type(self, name: str, description: str) -> ApiResponse:
  """Add a new Asset Type.
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  name: Name of the Asset type
@@ -297,7 +297,7 @@ def add_asset_type(self, name: str, description: str) -> ApiResponse:
  def delete_asset_type(self, asset_type_id: int) -> ApiResponse:
  """Delete an existing asset type by its ID.
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  asset_type_id: Asset type to delete
@@ -312,7 +312,7 @@ def update_asset_type(self, asset_type_id: int, name: str = None,
  description: str = None) -> ApiResponse:
  """Updates an Asset type. `asset_type_id` needs to be a valid existing AssetType ID.
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  asset_type_id: Asset type to update
@@ -344,7 +344,7 @@ def add_customer(self, customer_name: str):
  
  - customer_name is unique
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
  Args:
  customer_name: Name of the customer to add.
 
@@ -365,7 +365,7 @@ def update_customer(self, customer_id: int, customer_name: str):
  - `customer_id` is a know customer ID in IRIS
  - `customer_name` is unique
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  customer_id: ID of the customer to update
@@ -385,7 +385,7 @@ def update_customer(self, customer_id: int, customer_name: str):
  def delete_customer(self, customer: Union[str, int]) -> ApiResponse:
  """Deletes a customer from its ID or name.
  
- !!! tip Requires admin rights
+ !!! tip "Requires admin rights"
 
  Args:
  customer: Customer name or customer ID

setup.py

@@ -17,10 +17,15 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-
+import pathlib
 
 import setuptools
 
+# The directory containing this file
+CURR_DIR = pathlib.Path(__file__).parent
+
+# The text of the README file
+README = (CURR_DIR / "README.md").read_text()
 
 setuptools.setup(
  name='dfir_iris_client',
@@ -29,8 +34,7 @@
  author="DFIR-IRIS",
  author_email="[email protected]",
  description="Client for DFIR-IRIS API",
- long_description="A Python client to communicate with the DFIR-IRIS API, "
- "allowing to handle almost all features via Python",
+ long_description=README,
  long_description_content_type="text/markdown",
  url="https://github.com/dfir-iris/dfir-iris-client",
  classifiers=[