docs: Update README (#114)

Author: skupriienko

.pre-commit-config.yaml

@@ -66,7 +66,7 @@ repos:
         args: [--write]
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.30.0
+    rev: 0.31.0
     hooks:
       - id: check-github-workflows
 
@@ -103,21 +103,21 @@ repos:
 
 
   - repo: https://github.com/PyCQA/pylint
-    rev: v3.3.2
+    rev: v3.3.3
     hooks:
       - id: pylint
         args:
           - --exit-zero
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.0
+    rev: v3.19.1
     hooks:
       - id: pyupgrade
         args: [--py38-plus, --keep-runtime-typing]
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     # Ruff version.
-    rev: v0.8.2
+    rev: v0.9.2
     hooks:
       # Run the linter.
       - id: ruff
@@ -131,7 +131,7 @@ repos:
       -   id: refurb
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.13.0
+    rev: v1.14.1
     hooks:
     -   id: mypy
         args:
@@ -141,12 +141,12 @@ repos:
         exclude: ^samples/
 
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.390
+    rev: v1.1.392.post0
     hooks:
     - id: pyright
 
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.8.0
+    rev: 1.8.2
     hooks:
       - id: bandit
         args: ["-c", "pyproject.toml", "-r", "."]
@@ -155,7 +155,7 @@ repos:
         additional_dependencies: [".[toml]"]
 
   - repo: https://github.com/crate-ci/typos
-    rev: typos-dict-v0.11.37
+    rev: dictgen-v0.3.1
     hooks:
       - id: typos
 

Makefile

@@ -87,6 +87,11 @@ environment:    ## handles environment creation
 	conda env create -f environment.yaml --name $(CONDA_ENV_NAME) --yes
 	conda run --name $(CONDA_ENV_NAME) pip install .
 
+environment-dev:       ## Handles environment creation
+	conda env create -n $(CONDA_ENV_NAME)-dev -y --file environment-dev.yml
+	conda run --name $(CONDA_ENV_NAME)-dev pip install -e .
+	$(CONDA_ACTIVATE) $(CONDA_ENV_NAME)-dev
+
 install: clean	## install the package to the active Python's site-packages
 	pip install .
 
@@ -100,12 +105,12 @@ dist: clean ## builds source and wheel package
 dev: clean		## install the package's development version to a fresh environment
 	conda env create -f environment.yaml --name $(CONDA_ENV_NAME) --yes
 	conda run --name $(CONDA_ENV_NAME) pip install -e .
-	$(CONDA_ACTIVATE) $(CONDA_ENV_NAME) && pre-commit install
+	$(CONDA_ACTIVATE) $(CONDA_ENV_NAME)
 
 dev-full: clean		## install the package's development version to a fresh environment
-	conda env create -f environment-dev.yaml --name $(CONDA_ENV_NAME) --yes
-	conda run --name $(CONDA_ENV_NAME) pip install -e .
-	$(CONDA_ACTIVATE) $(CONDA_ENV_NAME) && pre-commit install
+	conda env create -f environment-dev.yaml --name $(CONDA_ENV_NAME)-dev --yes
+	conda run --name $(CONDA_ENV_NAME)-dev pip install -e .
+	$(CONDA_ACTIVATE) $(CONDA_ENV_NAME)-dev && pre-commit install
 
 
 pre-commit:     ## runs pre-commit against files. NOTE: older files are disabled in the pre-commit config.

README.md

@@ -20,6 +20,9 @@ Check out all the resources and Python code examples in the official [Mailjet Do
 ## Table of contents
 
 - [Compatibility](#compatibility)
+- [Requirements](#requirements)
+  - [Build backend](#build-backend)
+  - [Runtime](#runtime)
 - [Installation](#installation)
 - [Authentication](#authentication)
 - [Make your first call](#make-your-first-call)
@@ -42,18 +45,57 @@ Check out all the resources and Python code examples in the official [Mailjet Do
 
 ## Compatibility
 
-This library officially supports the following Python versions:
+This library `mailjet_rest` officially supports the following Python versions:
 
- - v2.7
- - v3.5
- - v3.6+
+ - v3.9+
+
+It's tested up to 3.12 (including).
+
+## Requirements
+
+### Build backend
+
+To build the `mailjet_rest` package you need `setuptools` (as a build backend) and `wheel`.
+
+### Runtime
+
+At runtime the package requires only `requests`.
 
 ## Installation
 
 Use the below code to install the wrapper:
 
 ``` bash
-(sudo) pip install mailjet_rest
+git clone https://github.com/mailjet/mailjet-apiv3-python
+cd mailjet-apiv3-python
+```
+
+``` bash
+pip install .
+```
+
+or using `conda` and `make` on Unix platforms:
+
+``` bash
+make install
+```
+
+### For development
+
+on Linux or macOS:
+
+- A basic environment with a minimum number of dependencies:
+
+``` bash
+make dev
+conda activate mailjet
+```
+
+- A full dev environment:
+
+``` bash
+make dev-full
+conda activate mailjet-dev
 ```
 
 ## Authentication

environment-dev.yaml

@@ -1,5 +1,5 @@
 ---
-name: mailjet_dev
+name: mailjet-dev
 channels:
   - defaults
 dependencies:

pyproject.toml

@@ -10,7 +10,7 @@ mailjet_rest = ["py.typed", "*.pyi"]
 
 [project]
 name = "mailjet_rest"
-version = "1.3.5"
+version = "1.4.0rc1"
 description = "Mailjet V3 API wrapper"
 authors = [
     { name = "starenka", email = "starenka0@gmail.com" },