Merge pull request #11 from TomerFi/minor-fixes

Minor fixes

.spelling

@@ -22,13 +22,12 @@ doc8.ini
 dockerfile
 docstrings
 figenblat
-http
 faq
-ferrarimarco
 flake8
 github
 googlecontainertools
 hadolint
+http
 isort
 jdkato
 joblint

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 
-## [0.2.6](https://github.com/tomerfi/switcher_webapi/tree/0.2.5) (2019-06-24)
+## [0.2.7](https://github.com/tomerfi/switcher_webapi/tree/0.2.7) (2019-06-25)
+
+[Full Changelog](https://github.com/tomerfi/switcher_webapi/compare/0.2.6...0.2.7)
+
+## [0.2.6](https://github.com/tomerfi/switcher_webapi/tree/0.2.6) (2019-06-24)
 
 [Full Changelog](https://github.com/tomerfi/switcher_webapi/compare/0.2.5...0.2.6)
 

CONTRIBUTING.md

@@ -1,8 +1,8 @@
 # Contributing to `switcher_webapi`
 
-First off, thank you for taking the time to contribute.
+:clap: First off, thank you for taking the time to contribute. :clap:
 
-> **Note**: This repository hosts a docker image wrapping a Rest API around the
+> **Note**: This repository is a docker image wrapping a python Rest API around the
 > `aioswitcher` pypi module.
 >
 > If your contribution is a more of a *core contribution*, please consider maybe
@@ -181,9 +181,9 @@ the npm requirements listed in the *package.json* file.
 
 ### Snyk
 [Snyk](https://snyk.io) is keeping an eye out for vulnerabilities in our
-[npm dependencies](https://app.snyk.io/org/tomerfi/project/87072022-903c-4190-9a21-58c005f20255),
-our [pypi dependencies](https://app.snyk.io/org/tomerfi/project/e06f1010-493f-45be-bb84-a80ddba9d358)
-and our [docker image dependencies](https://app.snyk.io/org/tomerfi/project/efb45c0a-f64b-4db5-8976-966508b78cd8).
+[npm dependencies](https://snyk.io/test/github/TomerFi/switcher_webapi?targetFile=package.json),
+our [pypi requirements](https://snyk.io/test/github/TomerFi/switcher_webapi?targetFile=requirements.txt)
+and our *docker image dependencies*.
 
 ## Continuous Deployment
 ### Docker Hub
@@ -396,11 +396,6 @@ The shell scripts in `shellscripts` were written for `bash` and not for `sh`.
         [koalaman/shellcheck](https://hub.docker.com/r/koalaman/shellcheck) for checking
         the shell scripts residing in [shellscripts](shellscripts/).
 
-    -   argument `generate-changelog` will execute the docker image
-        [ferrarimarco/github-changelog-generator](https://hub.docker.com/r/ferrarimarco/github-changelog-generator)
-        for generating a simple [CHANGELOG.md](CHANGELOG.md) based on `git-release-tags`,
-        the created file can be later used as a manual base for updating the documentation site.
-
     -   argument `circleci-validate` will execute the docker image
         [circleci/circleci-cli](https://hub.docker.com/r/circleci/circleci-cli)
         for validating the [.circleci/config.yml](.circleci/config.yml) file.

VERSION

@@ -1 +1 @@
-0.2.6
+0.2.7

docs/source/changelog.rst

@@ -1,6 +1,14 @@
 Change Log
 **********
 
+0.2.7_ (2019-06-25)
+^^^^^^^^^^^^^^^^^^^
+
+`0.2.7 Full Changelog`_
+
+- Updated dependencies and requirements
+- Documentation fix-ups
+
 0.2.6_ (2019-06-24)
 ^^^^^^^^^^^^^^^^^^^
 
@@ -77,6 +85,8 @@ Change Log
 
 -  Pre-release
 
+.. _0.2.7: https://github.com/tomerfi/switcher_webapi/tree/0.2.7
+.. _0.2.7 Full Changelog: https://github.com/tomerfi/switcher_webapi/compare/0.2.6...0.2.7
 .. _0.2.6: https://github.com/tomerfi/switcher_webapi/tree/0.2.6
 .. _0.2.6 Full Changelog: https://github.com/tomerfi/switcher_webapi/compare/0.2.5...0.2.6
 .. _0.2.5: https://github.com/tomerfi/switcher_webapi/tree/0.2.5

docs/source/contributing.rst

@@ -5,7 +5,7 @@ First off, thank you for taking the time to contribute.
 
 .. note::
 
-   This repository hosts a docker image wrapping a Rest API around the `aioswitcher pypi module`_.
+   This repository is a docker image wrapping a python Rest API around the `aioswitcher pypi module`_.
 
    If your contribution is a more of a *core contribution*, please consider maybe
    it belongs to the integrating module and not the wrapping docker.
@@ -165,7 +165,7 @@ Snyk
 ----
 
 Snyk_ is keeping an eye out for vulnerabilities in our `npm dependencies`_,
-our  `pypi dependencies`_ and our `docker image dependencies`_.
+our  `pypi requirements`_ and our *docker image dependencies*.
 
 Continuous Deployment
 ^^^^^^^^^^^^^^^^^^^^^
@@ -394,11 +394,6 @@ Shell Scripts
     *   **argument**: ``check-shellscripts`` will execute the docker image `koalaman/shellcheck`_
         for checking the shell scripts residing in ``shellscripts``.
 
-    *   **argument**: ``generate-changelog`` will execute the docker image
-        `ferrarimarco/github-changelog-generator`_ for generating a simple ``CHANGELOG.md`` based
-        on ``git-release-tags``.
-        The created file can be later used as a manual base for updating the documentation site.
-
     *   **argument**: ``circleci-validate`` will execute the docker image `circleci/circleci-cli`_
         for validating the ``.circleci/config.yml`` file.
 
@@ -511,7 +506,6 @@ Any contribution bumping up this percentage will be gladly embraced.
 .. _flake8: https://pypi.org/project/flake8/
 .. _mypy: https://pypi.org/project/mypy/
 .. _pytest: https://pypi.org/project/pytest/
-.. _ferrarimarco/github-changelog-generator: https://hub.docker.com/r/ferrarimarco/github-changelog-generator
 .. _circleci/circleci-cli: https://hub.docker.com/r/circleci/circleci-cli
 .. _Pytest, Full-featured Python testing tool: https://docs.pytest.org/en/latest/
 .. _semvar: https://semver.org/
@@ -525,13 +519,12 @@ Any contribution bumping up this percentage will be gladly embraced.
 .. _PEP518: https://www.python.org/dev/peps/pep-0518/
 .. _markdown-spellcheck: https://www.npmjs.com/package/markdown-spellcheck
 .. _snyk: https://snyk.io
-.. _npm dependencies: https://app.snyk.io/org/tomerfi/project/87072022-903c-4190-9a21-58c005f20255
-.. _pypi dependencies: https://app.snyk.io/org/tomerfi/project/e06f1010-493f-45be-bb84-a80ddba9d358
+.. _npm dependencies: https://snyk.io/test/github/TomerFi/switcher_webapi?targetFile=package.json
+.. _pypi requirements: https://snyk.io/test/github/TomerFi/switcher_webapi?targetFile=requirements.txt
 .. _vale: https://errata-ai.github.io/vale/
 .. _vale styles: https://errata-ai.github.io/vale/styles/
 .. _vale repository: https://github.com/errata-ai/vale/tree/master/docs/styles
 .. _jdkato/vale: https://hub.docker.com/r/jdkato/vale
-.. _docker image dependencies: https://app.snyk.io/org/tomerfi/project/efb45c0a-f64b-4db5-8976-966508b78cd8
 .. _proselint: https://github.com/amperser/proselint
 .. _write-good: https://github.com/btford/write-good
 .. _joblint: https://github.com/rowanmanning/joblint

package.json

@@ -1,6 +1,6 @@
 {
   "name": "switcher_webapi",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "description": "REST api wrapper for the aioswitcher pypi module running in a Docker image, used to integrate with the Switcher water heater.",
   "keywords": [
     "smarthome",
@@ -43,10 +43,10 @@
     "package-json-validator": "0.6.3",
     "remark-cli": "6.0.1",
     "remark-frontmatter": "1.3.2",
-    "remark-lint": "6.0.4",
-    "remark-preset-lint-consistent": "2.0.2",
-    "remark-preset-lint-markdown-style-guide": "2.1.2",
-    "remark-preset-lint-recommended": "3.0.2"
+    "remark-lint": "6.0.5",
+    "remark-preset-lint-consistent": "2.0.3",
+    "remark-preset-lint-markdown-style-guide": "2.1.3",
+    "remark-preset-lint-recommended": "3.0.3"
   },
   "private": true
 }

requirements.txt

@@ -11,7 +11,7 @@ doc8==0.8.0
 flake8==3.7.7
 flake8-docstrings==1.3.0
 isort==4.3.20
-mypy==0.710
+mypy==0.711
 mypy-extensions==0.4.1
 nodeenv==1.3.3
 Pygments==2.4.2

shellscripts/run-once-docker-operations.sh

@@ -16,7 +16,6 @@ display_usage() {
     echo -e "please provide the operation you want to execute.\n"
     echo "usage: $0 lint-dockerfile"
     echo "usage: $0 check-shellscripts"
-    echo "usage: $0 generate-changelog"
     echo "usage: $0 circleci-validate"
     echo "usage: $0 vale-rstdocs"
 }
@@ -35,11 +34,6 @@ then
       then
         # shellcheck disable=SC2046
         docker run --rm -it -v "$PWD/shellscripts/:/mnt/:ro" koalaman/shellcheck:v0.6.0 $(ls -A1 shellscripts)
-      elif [ "$1" = "generate-changelog" ]
-      then
-        docker run --rm -it -v "$PWD:/usr/local/src/your-app:ro" ferrarimarco/github-changelog-generator:latest --user tomerfi --project switcher_webapi --no-issues --no-unreleased --no-pull-requests
-        sed -i '$d' CHANGELOG.md
-        sed -i -e :a -e '/^\n*$/{$d;N;ba' -e '}' CHANGELOG.md
       elif [ "$1" = "circleci-validate" ]
       then
         docker run --rm -it -v "$PWD/.circleci/:/.circleci/:ro" circleci/circleci-cli:alpine config validate