Merge branch 'update-package-metadata' into 'master'

Apply updates from package template

See merge request Sensirion/Python/python-i2c-driver!15

Author: ubruhin

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+trim_trailing_whitespace = true
+
+[*.bat]
+end_of_line = crlf
+
+[*.hex]
+end_of_line = crlf

.gitattributes

@@ -1,4 +1,5 @@
 .idea/
+.vscode/
 .eggs/
 build/
 dist/

.gitignore

@@ -1,44 +1,49 @@
-include: https://gitlab/Sensirion/Python/ci-config-python/raw/master/gitlab-ci-template-v1.yml
+include: https://gitlab.sensirion.lokal/Sensirion/Python/ci-config-python/raw/master/gitlab-ci-template-v2.yml
 
 check_rst_syntax:
-  extends: .check_rst_syntax_v1
-  script:
-    - rst-lint *.rst
+  extends: .check_rst_syntax_v2
+
+check_editorconfig:
+  extends: .check_editorconfig_v2
+
+
+py2p7_linux_build:
+  extends: .py2p7_linux_build_v2
+
+py3p5_linux_build:
+  extends: .py3p5_linux_build_v2
 
+py3p6_linux_build:
+  extends: .py3p6_linux_build_v2
 
-py2p7_linux_build_v1:
-  extends: .py2p7_linux_build_v1
+py3p8_linux_build:
+  extends: .py3p8_linux_build_v2
 
-py3p5_linux_build_v1:
-  extends: .py3p5_linux_build_v1
 
+py2p7_32bit_win_build:
+  extends: .py2p7_32bit_win_docker_build_v2
 
-py2p7_32bit_win_build_v1:
-  extends: .py2p7_32bit_win_docker_build_v1
+py3p5_64bit_win_build:
+  extends: .py3p5_64bit_win_docker_build_v2
 
-py3p5_64bit_win_build_v1:
-  extends: .py3p5_64bit_win_docker_build_v1
+py3p8_64bit_win_build:
+  extends: .py3p8_64bit_win_docker_build_v2
 
 
 build_docs:
-  extends: .build_docs_v1
+  extends: .build_docs_v2
   script:
-    - apt-get update && apt-get install -y graphviz
     - python setup.py install
     - pip install -r docs/requirements.txt
     - ./ci/set_git_config.sh
     - sphinx-versioning build -r "$CI_COMMIT_REF_NAME" -w "$CI_COMMIT_REF_NAME" docs docs/_build/html
-  artifacts:
-    paths: [docs/_build]
-    expire_in: 1 week
-    when: always
 
 
-deploy_staging_v1:
-  extends: .deploy_staging_v1
+deploy_staging:
+  extends: .deploy_staging_v2
 
-deploy_stable_v1:
-  extends: .deploy_stable_v1
+deploy_stable:
+  extends: .deploy_stable_v2
   environment:
     name: pypi.org
     url: https://pypi.org/project/sensirion-i2c-driver/
@@ -54,11 +59,10 @@ deploy_stable_v1:
 deploy_docs:
   stage: deploy
   tags: [linux, docker]
-  image: registry.gitlab.sensirion.lokal/sensirion/docker/docker-python:3.6-18.04-1.1.0
+  image: registry.gitlab.sensirion.lokal/sensirion/docker/docker-python:3.6-18.04-2.7.0
   dependencies: []
   only: [master, tags]
   script:
-    - apt-get update && apt-get install -y graphviz
     - python setup.py install
     - pip install -r docs/requirements.txt
     - ./ci/set_git_config.sh

.gitlab-ci.yml

@@ -1,18 +1,18 @@
-CHANGELOG
----------
-
-1.0.0
-:::::
-- First public release
-- Add support for post processing time of commands
-- Add property ``is_multi_channel`` to ``I2cConnection``
-- Make API of ``SensirionWordI2cCommand`` byte-oriented
-- Rename class ``SensirionWordI2cCommand`` to ``SensirionI2cCommand``
-- Remove methods ``read()`` and ``write()`` from ``I2cConnection``
-- Remove asynchronous mode (including the ``read()`` method) from ``I2cDevice``
-- Log transceived raw data with ``log.debug()``
-- Various documentation improvements
-
-0.1.0
-:::::
-- Initial release
+CHANGELOG
+---------
+
+1.0.0
+:::::
+- First public release
+- Add support for post processing time of commands
+- Add property ``is_multi_channel`` to ``I2cConnection``
+- Make API of ``SensirionWordI2cCommand`` byte-oriented
+- Rename class ``SensirionWordI2cCommand`` to ``SensirionI2cCommand``
+- Remove methods ``read()`` and ``write()`` from ``I2cConnection``
+- Remove asynchronous mode (including the ``read()`` method) from ``I2cDevice``
+- Log transceived raw data with ``log.debug()``
+- Various documentation improvements
+
+0.1.0
+:::::
+- Initial release

CHANGELOG.rst

@@ -27,6 +27,14 @@ pip install -e .[test]  # Install requirements
 flake8                  # Run style check
 ```
 
+In addition, we check the formatting of files with
+[`editorconfig-checker`](https://editorconfig-checker.github.io/):
+
+```bash
+pip install editorconfig-checker==2.0.3   # Install requirements
+editorconfig-checker                      # Run check
+```
+
 ### Run tests
 
 Unit tests can be run with [`pytest`](https://pytest.org/):

README.md

@@ -9,7 +9,7 @@ echo "$SSH_DEPLOY_KEY" > ~/.ssh/id_rsa
 chmod 400 ~/.ssh/id_rsa
 
 # change remote URL to SSH to allow pushing with SSH
-git remote set-url --push origin "git@gitlab:${CI_PROJECT_PATH}.git"
+git remote set-url --push origin "git@${CI_SERVER_HOST}:${CI_PROJECT_PATH}.git"
 
 # set git author
 git config --global user.name "GitLab-CI"

ci/set_git_config.sh

@@ -1 +1 @@
-_build/
+/_build/

docs/.gitignore

@@ -1,10 +1,10 @@
 # Minimal makefile for Sphinx documentation
 #
 
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = sensirion-i2c-driver
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build