docs: Update README, CHANGELOG; fix Makefile, add .gitattributes

Author: skupriienko

.gitattributes

@@ -0,0 +1,14 @@
+# Automatically detect text files and perform LF normalization
+* text=auto
+
+# Source files should have Unix line endings
+*.py text eol=lf
+*.md text eol=lf
+*.toml text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
+
+# Exclude some files from exporting
+.gitattributes export-ignore
+.gitignore export-ignore
+.github export-ignore

CHANGELOG.md

@@ -2,19 +2,22 @@
 
 We [keep a changelog.](http://keepachangelog.com/)
 
-[Full Changelog](https://github.com/mailjet/mailjet-apiv3-python/compare/v1.3.2...HEAD)
+## [Unreleased]
 
-## Next release
+## [1.4.0] - 2025-XX-XX
 
-[Unreleased](https://github.com/mailjet/mailjet-apiv3-python/tree/HEAD)
+### Added
 
-## Version 1.4.0 (2025-XX-XX) - Public Release
+- Enabled debug logging
+- Support for Python >=3.9,\<3.13
+- CI Automation
+- Type hinting
+- Docstrings
+- A conda recipe
 
-### Tickets closed
+### Changed
 
-- [DE-1038](https://mailgun.atlassian.net/browse/DE-1038) - Enable PEP 8, 257, 484
-- [DE-1381](https://mailgun.atlassian.net/browse/DE-1381) - Enable debug logging
-- [DE-1521](https://mailgun.atlassian.net/browse/DE-1521) - Improve CI Automation
+- Update README.md
 
 ### Pull Requests Merged
 
@@ -124,3 +127,6 @@ We [keep a changelog.](http://keepachangelog.com/)
 [Full Changelog](https://github.com/mailjet/mailjet-apiv3-python/compare/19cf9a00a948e84de4842b51b0336e978f7a849f...v1.0.3)
 
 \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
+
+[1.4.0]: https://github.com/mailjet/mailjet-apiv3-python/releases/tag/v1.4.0
+[unreleased]: https://github.com/mailjet/mailjet-apiv3-python/releases/tag/v1.4.0...HEAD

Makefile

@@ -90,7 +90,6 @@ environment:    ## handles environment creation
 environment-dev:       ## Handles environment creation
 	conda env create -n $(CONDA_ENV_NAME)-dev -y --file environment-dev.yaml
 	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 .
@@ -105,14 +104,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)
 
 dev-full: clean		## install the package's development version to a fresh environment
 	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.
 	pre-commit run --all-files
 

README.md

@@ -3,7 +3,7 @@
 # Official Mailjet Python Wrapper
 
 [![Build Status](https://travis-ci.org/mailjet/mailjet-apiv3-python.svg?branch=master)](https://travis-ci.org/mailjet/mailjet-apiv3-python)
-![Current Version](https://img.shields.io/badge/version-1.3.2-green.svg)
+![Current Version](https://img.shields.io/badge/version-1.3.5-green.svg)
 
 ## Overview
 
@@ -15,16 +15,23 @@ Check out all the resources and Python code examples in the official [Mailjet Do
 
 - [Compatibility](#compatibility)
 - [Requirements](#requirements)
-  - [Build backend](#build-backend)
-  - [Runtime](#runtime)
+  - [Build backend dependencies](#build-backend-dependencies)
+  - [Runtime dependnecies](#runtime-dependencies)
+  - [Test dependencies](#test-dependencies)
 - [Installation](#installation)
+  - [pip install](#pip-install)
+    - [git clone & pip install locally](#git-clone--pip-install-locally)
+    - [conda & make](#conda--make)
+  - [For development](#for-development)
+    - [Using conda](#using-conda)
 - [Authentication](#authentication)
 - [Make your first call](#make-your-first-call)
 - [Client / Call configuration specifics](#client--call-configuration-specifics)
   - [API versioning](#api-versioning)
   - [Base URL](#base-url)
   - [URL path](#url-path)
 - [Request examples](#request-examples)
+  - [Full list of supported endpoints](#full-list-of-supported-endpoints)
   - [POST request](#post-request)
     - [Simple POST request](#simple-post-request)
     - [Using actions](#using-actions)
@@ -35,29 +42,46 @@ Check out all the resources and Python code examples in the official [Mailjet Do
     - [Retrieve a single object](#retrieve-a-single-object)
   - [PUT request](#put-request)
   - [DELETE request](#delete-request)
+- [License](#license)
 - [Contribute](#contribute)
+- [Contributors](#contributors)
 
 ## Compatibility
 
 This library `mailjet_rest` officially supports the following Python versions:
 
-- v3.9+
+- Python >=3.9,\<3.13
 
-It's tested up to 3.12 (including).
+It's tested up to 3.13 (including).
 
 ## Requirements
 
-### Build backend
+### Build backend dependencies
 
-To build the `mailjet_rest` package you need `setuptools` (as a build backend) and `wheel`.
+To build the `mailjet_rest` package from the sources you need `setuptools` (as a build backend), `wheel`, and `setuptools-scm`.
 
-### Runtime
+### Runtime dependencies
 
-At runtime the package requires only `requests`.
+At runtime the package requires only `requests >=2.32.3`.
+
+### Test dependencies
+
+For running test you need `pytest >=7.0.0` at least.
+Make sure to provide the environment variables from [Authentication](#authentication).
 
 ## Installation
 
-Use the below code to install the wrapper:
+### pip install
+
+Use the below code to install the the wrapper:
+
+```bash
+pip install mailjet-rest
+```
+
+#### git clone & pip install locally
+
+Use the below code to install the wrapper locally by cloning this repository:
 
 ```bash
 git clone https://github.com/mailjet/mailjet-apiv3-python
@@ -68,14 +92,18 @@ cd mailjet-apiv3-python
 pip install .
 ```
 
-or using `conda` and `make` on Unix platforms:
+#### conda & make
+
+Use the below code to install it locally by `conda` and `make` on Unix platforms:
 
 ```bash
 make install
 ```
 
 ### For development
 
+#### Using conda
+
 on Linux or macOS:
 
 - A basic environment with a minimum number of dependencies:
@@ -191,6 +219,11 @@ print(result.json())
 
 ## Request examples
 
+### Full list of supported endpoints
+
+> [!IMPORTANT]\
+> This is a full list of supported endpoints this wrapper provides [samples](samples)
+
 ### POST request
 
 #### Simple POST request
@@ -375,6 +408,10 @@ print(result.status_code)
 print(result.json())
 ```
 
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+
 ## Contribute
 
 Mailjet loves developers. You can be part of this project!
@@ -391,6 +428,12 @@ Feel free to ask anything, and contribute:
 
 If you have suggestions on how to improve the guides, please submit an issue in our [Official API Documentation repo](https://github.com/mailjet/api-documentation).
 
+## Contributors
+
+- [@diskovod](https://github.com/diskovod)
+- [@DanyilNefodov](https://github.com/DanyilNefodov)
+- [@skupriienko](https://github.com/skupriienko)
+
 [api_credential]: https://app.mailjet.com/account/apikeys
 [doc]: http://dev.mailjet.com/guides/?python#
 [mailjet]: (http://www.mailjet.com/)