feat: replaced pipenv to poetry. Updated dependencies (#337)

* feat: replaced pipenv to poetry. Updated dependencies

* docs: updated README

Author: avara1986

.github/workflows/python-package.yml

@@ -26,16 +26,17 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pipenv
-        pipenv lock --dev --requirements > requirements.txt
-        pip install -r requirements.txt
+        pip install poetry
+        poetry install --no-interaction --no-root
+      env:
+        POETRY_VIRTUALENVS_CREATE: false
     - name: Test with pytest
       run: |
-        python setup.py test
+        pytest --cov=project --cov=tests tests/
     - name: Run mypy
       continue-on-error: true
       run: |
-        mypy microservices-scaffold
+        mypy project
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

Pipfile

@@ -20,8 +20,34 @@ microservices with Python which handles cross-cutting concerns:
 
 ## Quickstart
 
+We recommended use [Poetry](https://python-poetry.org/docs/) to install the dependencies
+
+Start with poetry
+```shell
+pip install --user poetry
+poetry update
+poetry run python manage.py
+```
+
+Start with a virtualenv
+```shell
+pip install -r requirements.txt
+python manage.py
+```
+
+
+Open `http://127.0.0.1:5000/ui/` and play with swagger
+
 See our [quickstart webpage](https://python-microservices.github.io/scaffold/quickstart/)
 
+# Dependencies
+
+Updated dependencies in a requirements.txt with:
+
+```shell
+poetry export --dev -f requirements.txt --output requirements.txt
+```
+
 # How To contribute
 
 We appreciate opening issues and pull requests to make PyMS even more stable & useful! See [This doc](CONTRIBUTING.md)

Pipfile.lock

@@ -1,6 +1,4 @@
 # encoding: utf-8
-from flask_script import Manager
-
 from project.app import MyMicroservice
 
 
@@ -15,7 +13,5 @@ def create_app():
 
 app = create_app()
 
-manager = Manager(app)
-
 if __name__ == '__main__':
-    manager.run()
+    app.run()

README.md

@@ -1,16 +1,16 @@
 from marshmallow import fields
-from marshmallow_sqlalchemy import ModelSchema
+from marshmallow_sqlalchemy import SQLAlchemySchema
 
 from project.models.models import Film, Actor
 
 
-class ActorSchema(ModelSchema):
+class ActorSchema(SQLAlchemySchema):
     class Meta:
         model = Actor
         fields = ('id', 'name', 'surname')
 
 
-class FilmSchema(ModelSchema):
+class FilmSchema(SQLAlchemySchema):
     cast = fields.Nested(ActorSchema, many=True)
     pubDate = fields.String(required=True, data_key='pub_date', attribute="pub_date")
 

manage.py

@@ -1,3 +1,57 @@
+[tool.poetry]
+name = "MS-Scaffold"
+version = "2.3.0"
+description = "Python Miscroservice barebone"
+readme = "README.md"
+homepage = "https://python-microservices.github.io/"
+documentation = "https://python-microservices.github.io/"
+repository = "https://github.com/python-microservices/microservices-scaffold"
+license = "GPL-3.0-only"
+authors = ["avara1986 <a.vara.1986@gmail.com>"]
+classifiers = [
+    "Development Status :: 6 - Mature",
+    "Framework :: Flask",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[tool.poetry.dependencies]
+python = ">=3.6.2,<4.0"
+Flask-SQLAlchemy = "==2.5.1"
+SQLAlchemy = "==1.4.23"
+py-ms = {extras = ["all"], version = "==2.8.0"}
+marshmallow = "==3.13.0"
+marshmallow-sqlalchemy = ">=0.26.1"
+importlib-metadata = "==2.1.1"
+cryptography = "<3.4.8"
+
+[tool.poetry.dev-dependencies]
+requests-mock = "^1.9.3"
+coverage = ">=5.5"
+pytest = ">=5.4.3"
+pytest-cov = ">=2.12.1"
+pylint = ">=2.10.2"
+flake8 = "*"
+tox = ">=3.24.3"
+bandit = "*"
+safety = "*"
+pre-commit = ">=2.15.0"
+black = ">=21.8b0"
+mypy = ">=0.790"
+
 [tool.black]
 line-length = 120
 include = '\.pyi?$'

poetry.lock

@@ -1,5 +1,8 @@
-[aliases]
-test=pytest
+[metadata]
+name = MS-Scaffold
+author = attr:project.__author__
+author_email = attr:project.__email__
+version = attr:project.__version__
+description = Python Miscroservice barebone
+long_description = file: README.md, LICENSE
 
-[tool:pytest]
-addopts = --cov=project --cov=tests tests/

project/serializers/serializers.py

@@ -1,57 +1,5 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2018 by Alberto Vara <a.vara.1986@gmail.com>
-import codecs
-import os
+import setuptools
 
-from setuptools import setup, find_packages
-
-version = __import__("project").__version__
-author = __import__("project").__author__
-author_email = __import__("project").__email__
-
-if os.path.exists("README.rst"):
-    long_description = codecs.open("README.rst", "r", "utf-8").read()
-else:
-    long_description = "https://github.com/python-microservices/microservices-scaffold"
-
-setup(
-    name="MS-Scaffold",
-    version=version,
-    author=author,
-    author_email=author_email,
-    description="Python Miscroservice barebone",
-    long_description=long_description,
-    classifiers=[
-        "Development Status :: 6 - Mature",
-        "Environment :: Console",
-        "Intended Audience :: Developers",
-        "Intended Audience :: System Administrators",
-        "Natural Language :: English",
-        "License :: OSI Approved :: GPL License",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3.5",
-        "Programming Language :: Python :: 3.6",
-    ],
-    python_requires=">=3.5",
-    license="GPLv3",
-    platforms=["any"],
-    keywords="python, microservices",
-    url="https://github.com/python-microservices/microservices-scaffold",
-    packages=find_packages(
-        exclude=[
-            "*.tests",
-            "*.tests.*",
-            "tests.*",
-            "tests",
-            "*.examples",
-            "*.examples.*",
-            "examples.*",
-            "examples",
-        ]
-    ),
-    setup_requires=[
-        "pytest-runner>=2.0,<3dev",
-    ],
-    include_package_data=True,
-)
+if __name__ == "__main__":
+    setuptools.setup()

pyproject.toml

@@ -1,18 +1,17 @@
 [tox]
-envlist=py36,py37,pylint,flake8,safety,bandit,docs
+envlist=py36,py37,py38,pylint,flake8,safety,bandit
 
 [travis]
 python =
   3.6: py36
-  3.7: py37,pylint,flake8,bandit,docs
-  3.8: py38
+  3.7: py37
+  3.8: py38,pylint,flake8,bandit
 
 [testenv]
-deps = pipenv
 commands_pre=
-    pipenv install --dev --ignore-pipfile
+    poetry install --no-interaction --no-root
 commands=
-    python setup.py test
+    pytest --cov=project --cov=tests tests/
 [testenv:py36]
 basepython = python3.6
 [testenv:py37]