chore(pain001): ⬆️ Updated dependencies and documentation

sebastienrousseau · sebastienrousseau · commit f2215d9de2c6 · 2023-11-19T11:56:38.000Z
diff --git a/.gitignore b/.gitignore
@@ -84,10 +84,13 @@ celerybeat-schedule
 
 # virtualenv
 .venv
+.pain001/
+.pytest_cache/
 bandit-env
 myenv
 venv/
 ENV/
+pyvenv.cfg
 
 # Spyder project settings
 .spyderproject
@@ -114,3 +117,13 @@ ENV/
 # Database
 *.db-shm
 *.db-wal
+pain001/bin/activate
+pain001/bin/activate.csh
+pain001/bin/activate.fish
+pain001/bin/Activate.ps1
+pain001/bin/pip
+pain001/bin/pip3
+pain001/bin/pip3.11
+pain001/bin/python
+pain001/bin/python3
+pain001/bin/python3.11
diff --git a/Makefile b/Makefile
@@ -20,10 +20,10 @@
 
 dist:
 	rm -rf ./dist && \
-	python3 setup.py sdist bdist_wheel
+	python setup.py sdist bdist_wheel
 
 release: dist
 	bzr diff && \
 	twine upload dist/* && \
-	bzr tag $$(python3 setup.py --version|tail -1) && \
+	bzr tag $$(python setup.py --version|tail -1) && \
 	bzr push
diff --git a/README.md b/README.md
@@ -8,19 +8,13 @@
 
 ## Overview
 
-
-**Pain001** is an open-source Python Library that you can use to create
-**ISO 20022-Compliant Payment Files** directly from your **CSV** or **SQLite**
-Data Files.
+**Pain001** is an open-source Python Library that you can use to create **ISO 20022-Compliant Payment Files** directly from your **CSV** or **SQLite** Data Files.
 
 - **Website:** <https://pain001.com>
 - **Source code:** <https://github.com/sebastienrousseau/pain001>
 - **Bug reports:** <https://github.com/sebastienrousseau/pain001/issues>
 
-The Python library focuses specifically on
-**Payment Initiation and Advice Messages**, commonly known as **Pain**. In a
-very simplified way, a **pain.001** is a message that initiates the customer
-payment.
+The Python library focuses specifically on **Payment Initiation and Advice Messages**, commonly known as **Pain**. In a very simplified way, a **pain.001** is a message that initiates the customer payment.
 
 As of today the library is designed to be compatible with the:
 
@@ -32,21 +26,12 @@ As of today the library is designed to be compatible with the:
 - **Payments Initiation V08 (pain.001.001.08)**: Included support for the TARGET Instant Settlement Service (TISS) and introduced a new pain.002 message type for debit transfers.
 - **Payments Initiation V09 (pain.001.001.09)**: The latest version, which introduced support for Request for Account Information (RAI) functionality.
 
-Payments usually start with a **pain.001 payment initiation message**. The
-payer sends it to the payee (or the payee’s bank) via a secure network. This
-network could be **SWIFT** or **SEPA (Single Euro Payments Area) network**, or
-other payment networks such as **CHAPS**, **BACS**, **Faster Payments**, etc.
-The message contains the payer’s and payee’s bank account details, payment
-amount, and other information required to process the payment.
+Payments usually start with a **pain.001 payment initiation message**. The payer sends it to the payee (or the payee’s bank) via a secure network. This
+network could be **SWIFT** or **SEPA (Single Euro Payments Area) network**, or other payment networks such as **CHAPS**, **BACS**, **Faster Payments**, etc. The message contains the payer’s and payee’s bank account details, payment amount, and other information required to process the payment.
 
-The **Pain001** library can reduce payment processing complexity and costs by
-generating ISO 20022-compliant payment files. These files automatically remove
-the need to create and validate them manually, making the payment process more
-efficient and cost-effective. It will save you time and resources and minimises
-the risk of errors, making sure accurate and seamless payment processing.
+The **Pain001** library can reduce payment processing complexity and costs by generating ISO 20022-compliant payment files. These files automatically remove the need to create and validate them manually, making the payment process more efficient and cost-effective. It will save you time and resources and minimises the risk of errors, making sure accurate and seamless payment processing.
 
-Use the **Pain001** library to simplify, accelerate and automate your payment
-processing.
+Use the **Pain001** library to simplify, accelerate and automate your payment processing.
 
 ## Table of Contents
 
@@ -57,6 +42,10 @@ processing.
   - [Features](#features)
   - [Requirements](#requirements)
   - [Installation](#installation)
+    - [Install `virtualenv`](#install-virtualenv)
+    - [Create a Virtual Environment](#create-a-virtual-environment)
+    - [Activate environment](#activate-environment)
+    - [Getting Started](#getting-started)
   - [Quick Start](#quick-start)
     - [Arguments](#arguments)
   - [Examples](#examples)
@@ -110,33 +99,58 @@ processing.
 
 ## Requirements
 
-**Pain001** works with macOS, Linux and Windows and requires Python 3.9.0 and
-above.
+**Pain001** works with macOS, Linux and Windows and requires Python 3.9.0 and above.
 
 ## Installation
 
-It takes just a few seconds to get up and running with **Pain001**. You can
-install Pain001 from PyPI with pip or your favourite package manager:
+We recommend creating a virtual environment to install **Pain001**. This will ensure that the package is installed in an isolated environment and will not affect other projects. To install **Pain001** in a virtual environment, follow these steps:
+
+### Install `virtualenv`
+
+```sh
+python -m pip install virtualenv
+```
+
+### Create a Virtual Environment
+
+```sh
+python -m venv venv
+```
+
+| Code | Explanation |
+|---|---|
+| `-m` | executes module `venv` |
+| `env` | name of the virtual environment |
+
+### Activate environment
 
-Open your terminal and run the following command:
+```sh
+source venv/bin/activate
+```
+
+### Getting Started
+
+It takes just a few seconds to get up and running with **Pain001**. You can install Pain001 from PyPI with pip or your favourite package manager:
+
+Open your terminal and run the following command to add the latest version:
 
 ```sh
-pip install pain001
+python -m pip install pain001
 ```
 
-Add the -U switch to update to the current version, if `pain001` is already
-installed.
+Add the -U switch to update to the current version, if `pain001` is already installed. 
+
+```sh
+python -m pip install -U pain001
+```
 
 ## Quick Start
 
-After installation, you can run **Pain001** directly from the command line.
-Simply call the main module pain001 with the paths of your:
+After installation, you can run **Pain001** directly from the command line. Simply call the main module pain001 with the paths of your:
 
-- **XML template file** containing the various parameters you want to pass from
-  your Data file,
+- **XML template file** containing the various parameters you want to pass from your Data file,
 - **XSD schema file** to validate the generated XML file, and
-- **Data file (CSV or SQLite)** containing the payment instructions that you
-  want to submit.
+- **Data file (CSV or SQLite)** containing the payment instructions that you want to submit.
 
 Here’s how you would do that:
 
@@ -155,6 +169,7 @@ When running **Pain001**, you will need to specify four arguments:
 - An `xml_message_type`: This is the type of XML message you want to generate.
 
   The currently supported types are:
+
   - pain.001.001.03
   - pain.001.001.04
   - pain.001.001.05
@@ -208,9 +223,7 @@ GitHub:
 git clone https://github.com/sebastienrousseau/pain001.git
 ```
 
-  Then, navigate to the `pain001` directory and run the following command:
-
-  ```sh
+```sh
   python -m pain001 \
     -t pain.001.001.03 \
     -m templates/pain.001.001.03/template.xml \
diff --git a/TEMPLATE.md b/TEMPLATE.md
@@ -19,16 +19,47 @@ above.
 
 ## Installation
 
-It takes just a few seconds to get up and running with **Pain001**. You can
-install Pain001 from PyPI with pip or your favourite package manager:
+We recommend creating a virtual environment to install **Pain001**. This will ensure that the package is installed in an isolated environment and will not affect other projects. To install **Pain001** in a virtual environment, follow these steps:
 
-Open your terminal and run the following command:
+### Install `virtualenv`
 
 ```sh
-pip install pain001
+python -m pip install virtualenv
 ```
 
-Add the -U switch to update to the current version, if `pain001` is already
-installed.
+### Create a Virtual Environment
+
+```sh
+python -m venv venv
+```
+
+| Code | Explanation |
+|---|---|
+| `-m` | executes module `venv` |
+| `env` | name of the virtual environment |
+
+### Activate environment
+
+```sh
+source venv/bin/activate
+```
+
+### Getting Started
+
+It takes just a few seconds to get up and running with **Pain001**. You can install Pain001 from PyPI with pip or your favourite package manager:
+
+Open your terminal and run the following command to add the latest version:
+
+```sh
+python -m pip install pain001
+```
+
+Add the -U switch to update to the current version, if `pain001` is already installed. 
+
+```sh
+python -m pip install -U pain001
+```
 
 [banner]: https://kura.pro/pain001/images/banners/banner-pain001.svg 'Pain001, A Python Library for Automating ISO 20022-Compliant Payment Files Using CSV Or SQlite Data Files.'
+
+## Changelog
diff --git a/poetry.lock b/poetry.lock
diff --git a/requirements.txt b/requirements.txt
@@ -80,12 +80,12 @@ markupsafe==2.1.3 ; python_version >= "3.9" and python_version < "4.0" \
 mdurl==0.1.2 ; python_version >= "3.9" and python_version < "4.0" \
     --hash=sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8 \
     --hash=sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba
-pygments==2.16.1 ; python_version >= "3.9" and python_version < "4.0" \
-    --hash=sha256:13fc09fa63bc8d8671a6d247e1eb303c4b343eaee81d861f3404db2935653692 \
-    --hash=sha256:1daff0494820c69bc8941e407aa20f577374ee88364ee10a98fdbe0aece96e29
-rich==13.5.2 ; python_version >= "3.9" and python_version < "4.0" \
-    --hash=sha256:146a90b3b6b47cac4a73c12866a499e9817426423f57c5a66949c086191a8808 \
-    --hash=sha256:fb9d6c0a0f643c99eed3875b5377a184132ba9be4d61516a55273d3554d75a39
-xmlschema==2.4.0 ; python_version >= "3.9" and python_version < "4.0" \
-    --hash=sha256:d74cd0c10866ac609e1ef94a5a69b018ad16e39077bc6393408b40c6babee793 \
-    --hash=sha256:dc87be0caaa61f42649899189aab2fd8e0d567f2cf548433ba7b79278d231a4a
+pygments==2.17.1 ; python_version >= "3.9" and python_version < "4.0" \
+    --hash=sha256:1b37f1b1e1bff2af52ecaf28cc601e2ef7077000b227a0675da25aef85784bc4 \
+    --hash=sha256:e45a0e74bf9c530f564ca81b8952343be986a29f6afe7f5ad95c5f06b7bdf5e8
+rich==13.7.0 ; python_version >= "3.9" and python_version < "4.0" \
+    --hash=sha256:5cb5123b5cf9ee70584244246816e9114227e0b98ad9176eede6ad54bf5403fa \
+    --hash=sha256:6da14c108c4866ee9520bbffa71f6fe3962e193b7da68720583850cd4548e235
+xmlschema==2.5.0 ; python_version >= "3.9" and python_version < "4.0" \
+    --hash=sha256:276a03e0fd3c94c148d528bff4d9482f9b99bf8c7b4056a2e8e703d28149d454 \
+    --hash=sha256:f2b29c45485fac414cc1fdb38d18a220c5987d7d3aa996e6df6ff35ee94d5a63
diff --git a/setup.cfg b/setup.cfg
@@ -17,49 +17,20 @@
 [metadata]
 name = pain001
 version = 0.0.24
-description = Pain001, A Python Library for Automating ISO 20022-Compliant Payment Files Using CSV Or SQlite Data Files.
-keywords = pain001,iso20022,payment-processing,automate-payments,sepa,financial,banking-payments,csv,sqlite
-author = Sebastian Rousseau
-author_email = sebastian.rousseau@gmail.com
-url = https://github.com/sebastienrousseau/pain001
-license = Apache License 2.0
-license_files =
-    LICENSE-APACHE
-    LICENSE-MIT
-long_description = file: README.md
-long_description_content_type = text/markdown
-
-classifiers =
-    Development Status :: 4 - Beta
-    Intended Audience :: Developers
-    Intended Audience :: Financial and Insurance Industry
-    License :: OSI Approved :: Apache Software License
-    Operating System :: MacOS
-    Operating System :: OS Independent
-    Operating System :: POSIX
-    Operating System :: Unix
-    Programming Language :: Python
-    Programming Language :: Python :: 3.9
-    Programming Language :: Python :: 3.10
-    Programming Language :: Python :: 3.11
-    Topic :: Software Development :: Libraries :: Python Modules
-
-project_urls =
-    Documentation = https://pain001.com/
-    Funding = https://paypal.me/wwdseb
-    Source = https://github.com/sebastienrousseau/pain001/releases
 
 [options]
-packages =
-    pain001
-zip_safe = False
-include_package_data = True
-python_requires = ~=3.9
 install_requires =
-    click
-    defusedxml
-    rich
-    xmlschema
+    click==8.1.7
+    colorama==0.4.6
+    defusedxml==0.7.1
+    elementpath==4.1.5
+    jinja2==3.1.2
+    markdown-it-py==3.0.0
+    markupsafe==2.1.3
+    mdurl==0.1.2
+    pygments==2.17.1
+    rich==13.7.0
+    xmlschema==2.5.0
 
 [aliases]
 test = pytest
@@ -69,4 +40,3 @@ testpaths = tests
 
 [wheel]
 universal = 1
-
diff --git a/setup.py b/setup.py
