PEP 257 enabled (#110)

* docs: Add docstrings for packages, modules, classes, methods, and functions (following PEP 257 Docstring Conventions); apply linting

* docs: Enable docstring lints

* docs: Remove Return: None

* docs: Remove unused or fixed ruff lint rules

* ci: update pre-commit hooks

* docs: Add more docstring to tests

* docs: pydocstyle linting

Author: skupriienko

.pre-commit-config.yaml

@@ -117,7 +117,7 @@ repos:
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     # Ruff version.
-    rev: v0.7.1
+    rev: v0.7.2
     hooks:
       # Run the linter.
       - id: ruff
@@ -141,7 +141,7 @@ repos:
         exclude: ^samples/
 
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.387
+    rev: v1.1.388
     hooks:
     - id: pyright
 
@@ -155,7 +155,7 @@ repos:
         additional_dependencies: [".[toml]"]
 
   - repo: https://github.com/crate-ci/typos
-    rev: v1.26.8
+    rev: v1.27.0
     hooks:
       - id: typos
 

mailjet_rest/__init__.py

@@ -1,3 +1,19 @@
+"""The `mailjet_rest` package provides a Python client for interacting with the Mailjet API.
+
+This package includes the main `Client` class for handling API requests, along with
+utility functions for version management. The package exposes a consistent interface
+for Mailjet API operations.
+
+Attributes:
+    __version__ (str): The current version of the `mailjet_rest` package.
+    __all__ (list): Specifies the public API of the package, including `Client`
+        for API interactions and `get_version` for retrieving version information.
+
+Modules:
+    - client: Defines the main API client.
+    - utils.version: Provides version management functionality.
+"""
+
 from mailjet_rest.client import Client
 from mailjet_rest.utils.version import get_version