Converted project from using pipenv to poetry (#98)

* Added pyyaml package to Pipfile

Encountered an issue using `pipenv` after installing the
packages associated with the project for a missing package.

* Converted from pipenv to poetry

The Dockerfiles have also been modified using the recommended
install directions from the Poetry docs versus using pip to install
poetry.

* Updated Makefile for builds

* Traced remaining references to pipenv in project

Updated workflows in project to use Poetry.  Changed portions of
documentation to reflect change to poetry.

* Updated workflows to use poetry post-install

While poetry was successfully installing during the build, it was
not loaded into the current environment's `PATH`s so this adds the
command to load `poetry` into the active environment.

* Updated linter to use modules imported via poetry

`pipenv` with the `--system` argument was allowing for the packages
to be installed at the system level versus in a virtualenv which
resulted in `isort` throwing an error that the command did not exist.

The workflow has been modified to invoke poetry to utilize `isort` and
`black`.

Additionally, the `setup.py` and `setup.cfg` files have been re-added
back into this branch for compatibility.

* Changed poetry to export requirements.txt for builds

Using `pip` to install packages from poetry during build steps versus
trying to use the venv since the venv is not being used post-install
of packages through `poetry`

* Linter modified cloudendure.py formatting

* Fixed version and author information

Added the appropriate `authors` and `version` to the
`pyproject.toml` file for the project.

* Versioned to 0.2.0

Bumped the version to `0.2.0` with the assumption that moving from
`pipenv` to `poetry` is an impactful change to the project but
not a breaking change to how the `cloudendure` module functions.

The above context is driven using [Semantic Versioning](https://semver.org/).

* Fixed poetry build and other recommendations applied

- Cleaned up `setup.py` and `setup.cfg`
  - This was cruft left for mid-troubleshoot to resolve testing
- Updated `Makefile` to use `poetry build` and `poetry publish`
  for project builds
- Updated `API_README.md` in `docs` to reflect the change to the
  `poetry` from `pipenv`

* Ported items from original config to toml file

- Added `include`s for:
  - `CHANGELOG.md`
  - `CODE_OF_CONDUCT.md`
  - `REFERENCE.md`
  - `SECURITY.md`
- Cleaned up error in `tool.poetry.dependencies` attempting
  to reference the project itself
- `console scripts` have been ported for `cloudendure` and `ce`
  commands
- `tool.isort` and `tool.yapf` sections from the original `setup.cfg`
  have been ported to the toml file

* Added trailing comma to list in toml file

* Preparation for moving to poetry from pipenv

Author: selpan

.github/workflows/gh-pages.yml

@@ -20,8 +20,10 @@ jobs:
       if: success()
       run: |
         python -m pip install --upgrade pip
-        pip install pipenv
-        pipenv install --dev --pre --system --deploy
+        curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
+        source $HOME/.poetry/env
+        poetry export -f requirements.txt -o requirements.txt --dev
+        pip install -r requirements.txt
     - name: Build with MkDocs
       if: success()
       run: pydocmd build

.github/workflows/lint-python.yml

@@ -22,8 +22,11 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine pipenv
-        pipenv install --dev --pre --system --deploy
+        pip install setuptools wheel twine
+        curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
+        source $HOME/.poetry/env
+        poetry export -f requirements.txt -o requirements.txt --dev
+        pip install -r requirements.txt
     - name: Check python imports with isort
       run: |
         isort --version-number

.github/workflows/pypi-publish.yml

@@ -20,8 +20,10 @@ jobs:
       if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
       run: |
         python -m pip install --upgrade pip
-        pip install pipenv
-        pipenv install --dev --pre --system --deploy
+        curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
+        source $HOME/.poetry/env
+        poetry export -f requirements.txt -o requirements.txt --dev
+        pip install -r requirements.txt
     - name: Build and publish the pypi package
       if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
       run: python3 setup.py upload

.travis.yml

@@ -15,7 +15,7 @@ jobs:
     - stage: publish
       python: '3.7'
       script:
-        - pipenv install --dev
+        - poetry install
         - pydocmd build
       deploy:
         - provider: pages

Dockerfile

@@ -12,8 +12,10 @@ RUN apt-get -qq install ${SYSTEM_PACKAGES}
 COPY . /app
 
 RUN pip install --upgrade pip
-RUN pip install --upgrade wheel setuptools twine pipenv
-RUN pipenv install --dev --system --deploy
+RUN pip install --upgrade wheel setuptools twine
+RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
+RUN source $HOME/.poetry/env
+RUN poetry install
 
 RUN apt-get clean autoclean && \
     apt-get autoremove --yes && \

Dockerfile-py38

@@ -10,8 +10,10 @@ RUN apt-get -qq install ${SYSTEM_PACKAGES}
 COPY . /app
 
 RUN pip install --upgrade pip
-RUN pip install --upgrade wheel setuptools twine pipenv
-RUN pipenv install --dev --system --deploy
+RUN pip install --upgrade wheel setuptools twine
+RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
+RUN source $HOME/.poetry/env
+RUN poetry install
 
 RUN apt-get clean autoclean && \
     apt-get autoremove --yes && \

MANIFEST.in

@@ -55,42 +55,43 @@ push: ## Push the Docker image to the Docker Hub repository.
 docker: build build_py38 ## Build and publish Docker images.
 
 lint: isort ## Lint the CloudEndure project with Black.
-	@pipenv run black --target-version py37 .
+	@poetry run black --target-version py37 .
 
 update_prereqs: ## Update the local development pre-requisite packages.
-	@pip install --upgrade pipenv wheel setuptools pip
+	@pip install --upgrade wheel setuptools pip
 
 install-py-deps: update_prereqs ## Install the Python dependencies specified in the Pipfile.lock.
 	@echo "Installing Python project dependencies..."
-	@pipenv install --dev --pre
+	@poetry install
 	@echo "Python dependencies installed!"
 
 init: ## Initialize the project.
-	@pip install --upgrade pipenv wheel setuptools pip
-	@pipenv install --dev --pre
+	@pip install --upgrade wheel setuptools pip
+	@curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
+	@source $HOME/.poetry/env
+	@poetry install
 
 ci: ## Run the CI specific tests.
-	@pipenv run py.test -n 8 --boxed --junitxml=report.xml
+	@poetry run py.test -n 8 --boxed --junitxml=report.xml
 
 flake8: ## Run Flake8 against the project.
-	@pipenv run flake8 --ignore=E501,F401,E128,E402,E731,F821 cloudendure
+	@poetry run flake8 --ignore=E501,F401,E128,E402,E731,F821 cloudendure
 
 yapf: ## Run YAPF against the project.
-	@pipenv run yapf cloudendure
+	@poetry run yapf cloudendure
 
 isort: ## Run isort against the project.
-	@pipenv run isort -sp=setup.cfg -rc .
+	@poetry run isort -sp=setup.cfg -rc .
 
 coverage: ## Generate a test coverage report.
-	pipenv run py.test --cov-config .coveragerc --verbose --cov-report term --cov-report xml --cov=cloudendure tests
+	poetry run py.test --cov-config .coveragerc --verbose --cov-report term --cov-report xml --cov=cloudendure tests
 
 publish: ## Publish the package to PyPi.
-	pipenv run python3 setup.py sdist bdist_wheel
-	pipenv run twine upload dist/*
-	rm -fr build dist .egg requests.egg-info
+	poetry build
+	poetry publish
 
 docs: ## Build the documentation.
-	pipenv run pydocmd build
+	poetry run pydocmd build
 
 update_fork: ## Update the current fork master branch with upstream master.
 	@echo "Updating the current fork with the upstream master branch..."
@@ -103,14 +104,14 @@ update_fork: ## Update the current fork master branch with upstream master.
 gen_client: ## Generate the swagger client from the API config.
 	@swagger-codegen generate -i https://console.cloudendure.com/api_doc/apis.json -l python --model-name-prefix CloudEndure --git-user-id mbeacom --git-repo-id cloudendure-python -c reference/swagger_config.json -o gen/
 
-update_deps: update_prereqs ## Update the package dependencies via pipenv.
-	@pipenv update --pre --dev
+update_deps: update_prereqs ## Update the package dependencies via poetry.
+	@poetry update
 
 install: isort build_py ## Install the local development version of the module.
-	@pipenv install .
+	@poetry install .
 
 build_py: update_deps ## Build and package the project for PyPi source and wheel distribution.
-	@pipenv run python3 setup.py sdist bdist_wheel
+	@poetry build
 
 help: ## Show this help information.
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-25s\033[0m %s\n", $$1, $$2}'