GH-80: Support poetry build system

- Add pyproject.toml.
- Update README.rst with poetry steps for installing mdutils.
- Update README.md with poetry steps for installing mdutils.
- Update CONTRIBUTION.md file.

Author: Dídac Coll

.vscode/settings.json

@@ -4,5 +4,6 @@
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
-    "python.formatting.provider": "black"
+    "python.formatting.provider": "black",
+    "esbonio.sphinx.confDir": ""
 }

CONTRIBUTING.md

@@ -13,9 +13,10 @@ Please note we have a code of conduct, please follow it in all your interactions
 ## Deployment
 
 1. The versioning scheme we use is [SemVer](http://semver.org/).
-2. Increase the version number in `mdutils/doc/source/config.py` file.
-3. Increase the version number in `mdutils/setup.py` file.
-4. Increate the version number to `.github_changelog_generator` file.
+2. Increase the version number in the `mdutils/doc/source/config.py` file.
+3. Increase the version number in the `mdutils/setup.py` file.
+3. Increase the version number in the `mdutils/pyproject.toml` file.
+4. Increate the version number in the `.github_changelog_generator` file.
 5. Run `github_changelog_generator -u didix21 -p mdutils`.
 6. Run `python setup.py sdist --formats=gztar,zip`.
 7. Upload package to pypi: `twine upload dist/*`.

README.md

@@ -51,11 +51,21 @@ Markdown
 
 Installation
 ============
+
+Pip
+---
 Use pip to install mdutils:
 ```bash
 $ pip install mdutils
 ```
 
+Poetry
+------
+Use poetry to install mdutils:
+```bash
+$ poetry add mdutils
+```
+
 Markdown File Example
 =====================
 

doc/source/README.rst

@@ -47,22 +47,32 @@ Markdown
 
 Installation
 ============
+
+Pip
+---
 Use pip to install mdutils:
 
 .. code:: bash
 
     $ pip install mdutils
 
+Poetry
+------
+Use poetry to install mdutils:
+
+.. code:: bash
+
+    $ poetry add mdutils
 
 
-.. |build-status| image:: https://travis-ci.org/didix21/mdutils.svg?branch=master
-    :target: https://travis-ci.org/didix21/mdutils
+.. |build-status| image:: https://github.com/didix21/mdutils/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/didix21/mdutils
     :alt: Build Status
 
 .. |documentation-status| image:: https://readthedocs.org/projects/mdutils/badge/?version=latest
     :target: http://mdutils.readthedocs.io/en/latest/?badge=latest
     :alt: Documentation Status
 
-.. |coverage-status| image:: https://coveralls.io/repos/github/didix21/mdutils/badge.svg?branch=add-coveralls
-    :target: https://coveralls.io/github/didix21/mdutils?branch=add-coveralls
+.. |coverage-status| image:: https://codecov.io/gh/didix21/mdutils/branch/master/graph/badge.svg?token=0DN72Z1B6V
+    :target: https://codecov.io/gh/didix21/mdutils
     :alt: Coverage Status

pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+
+[tool.poetry]
+name = "mdutils"
+version = "1.5.1"
+description = "Useful package for creating Markdown files while executing python code."
+authors = ["Didac Coll <[email protected]>"]
+maintainers = ["Didac Coll <[email protected]>"]
+license = "MIT"
+readme = "./doc/source/README.rst"
+homepage = "https://github.com/didix21/mdutils"
+repository = "https://github.com/didix21/mdutils"
+documentation = "http://mdutils.readthedocs.io"
+keywords = ["Markdown"]
+include = ["mdutils/**"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Topic :: Utilities",
+    "Topic :: Software Development :: Documentation",
+    "Topic :: Text Processing :: Markup",
+    "License :: OSI Approved :: MIT License",
+]
+exclude = ["*.pyc", "*.pyo", "*.pyd", "Pyrex/*", "pyx/*", ".git/*", ".hg/*", ".bzr/*", "_darcs/*", "*.egg-info/*", ".svn/*", ".github/*", ".DS_Store", ".vscode"]
+
+[tool.poetry.dependencies]
+python = "^3.6"
+

scripts/update-release.py

@@ -2,6 +2,7 @@
 
 import getopt, sys
 import re
+import subprocess
 
 
 def usage():
@@ -21,23 +22,31 @@ def replace_on(file, pattern, new_value):
         file.write(new_content)
 
 
-def replace_version_on_config_py(version):
+def replace_version_on_config_py(version: str):
     file_name = "doc/source/conf.py"
     replace_on(file_name, r"release = '(\d+).(\d+).(\d+)'", f"release = '{version}'")
 
 
-def replace_version_on_setup_py(version):
+def replace_version_on_setup_py(version: str):
     file_name = "setup.py"
     replace_on(file_name, r"version='(\d+).(\d+).(\d+)'", f"version='{version}'")
 
 
-def replace_version_on_changelog_gen(version):
+def replace_version_on_changelog_gen(version: str):
     file_name = ".github_changelog_generator"
     replace_on(
         file_name, r"future-release=v(\d+).(\d+).(\d+)", f"future-release={version}"
     )
 
 
+def update_versiono_pyproject_toml(version: str):
+    shell(["poetry", "version", version])
+
+
+def shell(command):
+    return subprocess.run(command, text=True)
+
+
 def main():
     version = None
     try:
@@ -58,6 +67,7 @@ def main():
     replace_version_on_setup_py(version_number)
     replace_version_on_config_py(version_number)
     replace_version_on_changelog_gen(version)
+    update_versiono_pyproject_toml(version_number)
 
 
 if __name__ == "__main__":