Merge pull request #29 from python-microservices/feature/pipenv

Add Pipenv support

Author: avara1986

.travis.yml

@@ -2,6 +2,7 @@ language: python
 python:
     - '3.6'
 install:
+  - pip install pipenv
   - pip install -U tox coveralls
 
 script:

Pipfile

@@ -0,0 +1,25 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+flask = "*"
+jaeger-client = "==3.12.0"
+python-json-logger = "==0.1.10"
+pyyaml = "==3.13"
+anyconfig = "==0.9.8"
+swagger-ui-bundle = "==0.0.2"
+connexion = {extras = ["swagger-ui"],version = "==2.1.0"}
+flask-opentracing = "==0.2.0"
+
+[dev-packages]
+requests-mock = "*"
+coverage = "*"
+mock = "*"
+nose = "*"
+pylint = "*"
+tox = "*"
+
+[requires]
+python_version = "3.6"

Pipfile.lock

@@ -35,3 +35,49 @@ Encapsulate common rest operations between business services propagating trace h
 
 ### pyms/tracer
 Create an injector `flask_opentracing.FlaskTracer` to use in our projects
+
+## Pipenv
+
+### Advantages over plain pip and requirements.txt
+[Pipenv](https://pipenv.readthedocs.io/en/latest/) generates two files: a `Pipfile`and a `Pipfile.lock`.
+* `Pipfile`: Is a high level declaration of the dependencies of your project. It can contain "dev" dependencies (usually test related stuff) and "standard" dependencies which are the ones you'll need for your project to function
+* `Pipfile.lock`: Is the "list" of all the dependencies your Pipfile has installed, along with their version and their hashes. This prevents two things: Conflicts between dependencies and installing a malicious module.
+
+### How to...
+
+Here the most 'common' `pipenv` commands, for a more in-depth explanation please refer to  the [official documentation](https://pipenv.readthedocs.io/en/latest/).
+
+#### Install pipenv
+```bash
+pip install pipenv
+```
+
+#### Install dependencies defined in a Pipfile
+```bash
+pipenv install
+```
+
+#### Install both dev and "standard" dependencies defined in a Pipfile
+```bash
+pipenv install --dev
+```
+
+#### Install a new module
+```bash
+pipenv install django
+```
+
+#### Install a new dev module (usually test related stuff)
+```bash
+pipenv install nose --dev
+```
+
+#### Install dependencies in production
+```bash
+pipenv install --deploy
+```
+
+#### Start a shell
+```bash
+pipenv shell
+```

README.md

@@ -3,6 +3,7 @@
 import codecs
 import os
 
+import json
 from setuptools import setup, find_packages
 
 author = __import__('pyms').__author__
@@ -14,9 +15,21 @@
 else:
     long_description = ''
 
-# parse_requirements() returns generator of pip.req.InstallRequirement objects
-with open('requirements.txt') as f:
-    required = [lib for lib in f.read().splitlines() if not lib.startswith("-e")]
+
+
+install_requires = []
+tests_require = []
+if os.path.exists('Pipfile.lock'):
+    with open('Pipfile.lock') as fd:
+        lock_data = json.load(fd)
+        install_requires = [
+            package_name + package_data['version']
+            for package_name, package_data in lock_data['default'].items()
+        ]
+        tests_require = [
+            package_name + package_data['version']
+            for package_name, package_data in lock_data['develop'].items()
+        ]
 
 setup(
     name="py-ms",
@@ -26,18 +39,21 @@
     description="",
     long_description=long_description,
     classifiers=[
-        'Development Status :: 6 - Mature',
+        'Development Status :: 3 - Alpha',
+        'Framework :: Flask',
         "Intended Audience :: Developers",
         "Natural Language :: English",
         "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
     ],
-    license="Proprietary",
+    license="License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
     platforms=["any"],
     keywords="",
     url='',
     test_suite='nose.collector',
     packages=find_packages(),
-    install_requires=required,
+    install_requires=install_requires,
+    tests_require=tests_require,
     include_package_data=True,
     zip_safe=True,
-)
+)

requirements-tests.txt

@@ -16,10 +16,10 @@ whitelist_externals = /bin/bash
 
 [testenv:py36]
 basepython = python3.6
-deps = -rrequirements-tests.txt
-[testenv:py35]
-basepython = python3.5
-deps = -rrequirements-tests.txt
-[testenv:py27]
-basepython = python2.7
-deps = -rrequirements-tests.txt
+deps = pipenv
+commands=
+    pipenv install --dev --ignore-pipfile
+    python setup.py test
+setenv=
+    LC_ALL=en_GB.UTF-8
+    LANG=en_GB.UTF-8