A big repo cleanup (#182)

* a big repo cleanup

* fix permissions

* try to fix osx

* fix syntax, add doc

* fix test

* fix formatting

* fix formatting

* fix crash

* trying to fix travis issues

* fix tests, more cleanup, fix other builds

* replace all server starting with multiprocess

* fix containers

Co-authored-by: Gijs Molenaar <[email protected]>

.dockerignore

@@ -0,0 +1 @@
+.gitignore

.gitignore

@@ -50,3 +50,4 @@ doc/_build/
 .virtualenv3/
 .venv/
 .venv3/
+venv/

.travis.yml

@@ -1,36 +1,44 @@
-language: python
 matrix:
-    include:
-        - os: linux
-          sudo: required
-          python: 3.6
-        - os: linux
-          sudo: required
-          python: 3.6
-        - os: linux
-          sudo: required
-          python: 3.7
-        - os: linux
-          sudo: required
-          python: 3.8
-        - os: osx
-          language: generic
-          env: PYENV=3
+  include:
+    - os: linux
+      env: TARGET=ubuntu1804
+      services: [docker]
+      sudo: true
+    - os: linux
+      env: TARGET=ubuntu2004
+      services: [docker]
+      sudo: true
+    - os: linux
+      env:
+        - TARGET=mypy
+        - NOSCRIPT=true
+      services: [docker]
+      sudo: true
+    - os: linux
+      env:
+        - TARGET=pycodestyle
+        - NOSCRIPT=true
+      services: [docker]
+      sudo: true
+    - os: linux
+      env:
+        - TARGET=doc
+        - NOSCRIPT=true
+      services: [docker]
+      sudo: true
+    - os: osx
+      osx_image: xcode12
+
+
 before_install:
   - .travis/before_install.sh
+
 install:
-  - python${PYENV} setup.py install
+  - .travis/install.sh
+
 script:
   - .travis/script.sh
-after_success:
-  - codecov
-notifications:
-  webhooks:
-    urls:
-      - https://webhooks.gitter.im/e/aacaa796672a51d47850
-    on_success: change
-    on_failure: always
-    on_start: false
+
 deploy:
   provider: pypi
   user: gijzelaerr

.travis/before_install.sh

@@ -1,19 +1,12 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-set -x
+set -v
+set -e
 
 if [ "$TRAVIS_OS_NAME" = "osx" ]; then
     brew install snap7
-    pip install nose mock coverage
-    pip3 install nose mock coverage
 fi
 
 if [ "$TRAVIS_OS_NAME" = "linux" ]; then
-	sudo apt-get update -qq
-	sudo apt-get install -y software-properties-common
-	sudo add-apt-repository -y ppa:gijzelaar/snap7
-	sudo apt-get update -qq
-	sudo apt-get install -y libsnap7-dev libsnap71
+    echo "nothing"
 fi
-
-pip${PYENV} install -r test/requirements.txt

.travis/doc.docker

@@ -0,0 +1,12 @@
+FROM ubuntu:20.04
+
+RUN apt-get update -qq
+RUN apt-get install -y software-properties-common
+RUN add-apt-repository -y ppa:gijzelaar/snap7
+RUN apt-get update -qq
+RUN apt-get install -y libsnap7-dev libsnap7-1 python3-venv make
+ADD . /code
+WORKDIR /code
+ENV PATH="/code/venv/bin:$PATH"
+RUN make doc
+

.travis/install.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+set -v
+set -e
+
+
+if [ "$TRAVIS_OS_NAME" = "osx" ]; then
+    make setup
+fi
+
+if [ "$TRAVIS_OS_NAME" = "linux" ]; then
+     docker build . -f .travis/${TARGET}.docker -t python-snap7/${TARGET}
+fi
+
+

.travis/mypy.docker

@@ -0,0 +1,10 @@
+FROM ubuntu:20.04
+
+RUN apt-get update -qq
+RUN apt-get install -y software-properties-common
+RUN add-apt-repository -y ppa:gijzelaar/snap7
+RUN apt-get update -qq
+RUN apt-get install -y libsnap7-dev libsnap7-1 python3-venv make
+ADD . /code
+WORKDIR /code
+RUN make mypy

.travis/pycodestyle.docker

@@ -0,0 +1,10 @@
+FROM ubuntu:20.04
+
+RUN apt-get update -qq
+RUN apt-get install -y software-properties-common
+RUN add-apt-repository -y ppa:gijzelaar/snap7
+RUN apt-get update -qq
+RUN apt-get install -y libsnap7-dev libsnap7-1 python3-venv make
+ADD . /code
+WORKDIR /code
+RUN make pycodestyle

.travis/script.sh

@@ -1,17 +1,13 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-set -x
+set -v
+set -e
 
-if [ "$TRAVIS_OS_NAME" = "linux" ]; then
-    NOSETESTS=${VIRTUAL_ENV}/bin/nosetests
-else
-    NOSETESTS="python${PYENV} -m nose"
+if [ "$TRAVIS_OS_NAME" = "osx" ]; then
+  source venv/bin/activate
+  make test
 fi
 
-PYTHONPATH=.
-
-${NOSETESTS} --with-coverage test/test_server.py
-${NOSETESTS} --with-coverage test/test_client.py
-${NOSETESTS} --with-coverage test/test_client_async.py
-${NOSETESTS} --with-coverage test/test_util.py
-sudo ${NOSETESTS} --with-coverage test/test_partner.py
+if [ "$TRAVIS_OS_NAME" = "linux" ] && [ "$NOSCRIPT" != "true" ]; then
+    docker run python-snap7/${TARGET} make test
+fi

.travis/ubuntu1804.docker

@@ -0,0 +1,10 @@
+FROM ubuntu:18.04
+
+RUN apt-get update -qq
+RUN apt-get install -y software-properties-common
+RUN add-apt-repository -y ppa:gijzelaar/snap7
+RUN apt-get update -qq
+RUN apt-get install -y libsnap7-dev libsnap7-1 python3-venv make sudo
+ADD . /code
+WORKDIR /code
+RUN make test

.travis/ubuntu2004.docker

@@ -0,0 +1,10 @@
+FROM ubuntu:20.04
+
+RUN apt-get update -qq
+RUN apt-get install -y software-properties-common
+RUN add-apt-repository -y ppa:gijzelaar/snap7
+RUN apt-get update -qq
+RUN apt-get install -y libsnap7-dev libsnap7-1 python3-venv make sudo
+ADD . /code
+WORKDIR /code
+RUN make test

Makefile

@@ -0,0 +1,51 @@
+# developer file, not intented for installing python-snap7
+
+.PHONY: test
+
+allll: test
+
+venv/:
+	python3 -m venv venv
+	venv/bin/pip install --upgrade pip wheel
+
+venv/installed: venv/
+	venv/bin/pip install -e .
+	touch venv/installed
+
+setup: venv/installed
+
+venv/bin/pytest: venv/
+	venv/bin/pip install -e ".[test]"
+
+venv/bin/sphinx-build:  venv/
+	venv/bin/pip install -e ".[doc]"
+
+doc: venv/bin/sphinx-build
+	cd doc && make html
+
+pycodestyle: venv/bin/pytest
+	venv/bin/pycodestyle snap7 test
+
+mypy: venv/bin/pytest
+	venv/bin/mypy snap7 test
+
+test: venv/bin/pytest
+	venv/bin/pytest test/test_server.py test/test_client.py test/test_util.py
+	sudo venv/bin/pytest test/test_partner.py  # run this as last to prevent pytest cache dir creates as root
+
+docker-doc:
+		docker build . -f .travis/doc.docker -t doc
+
+docker-mypy:
+	docker build . -f .travis/mypy.docker -t mypy
+
+docker-pycodestyle:
+	docker build . -f .travis/pycodestyle.docker -t pycodestyle
+
+docker-ubuntu1804:
+	docker build . -f .travis/ubuntu1804.docker -t ubuntu1804
+
+docker-ubuntu2004:
+	docker build . -f .travis/ubuntu2004.docker -t ubuntu2004
+
+dockers: docker-doc docker-mypy docker-pycodestyle docker-ubuntu1804 docker-ubuntu2004

README.rst

@@ -7,17 +7,12 @@ with Siemens S7 PLCs.
 
 python-snap7 is tested with Python 3.6+, on Windows, Linux and OS X.
 
-**Since 17.07.2020 the Support for Python <3.6 is dropped!**
 
 .. image:: https://travis-ci.org/gijzelaerr/python-snap7.png?branch=master 
   :target: https://travis-ci.org/gijzelaerr/python-snap7
 
-.. image:: http://codecov.io/github/gijzelaerr/python-snap7/coverage.svg?branch=master
-  :target: http://codecov.io/github/gijzelaerr/python-snap7?branch=master
-
 The full documentation is available on `Read The Docs <http://python-snap7.readthedocs.org/en/latest/>`_.
 
-see `python-snap7 in action <http://youtu.be/G-Gj_r2BQBk/>`_.
 
 Installation
 ============

example/boolean.py

@@ -32,7 +32,7 @@
 # then you can specify an area to read from:
 # https://github.com/gijzelaerr/python-snap7/blob/master/snap7/snap7types.py
 
-from snap7.snap7types import area
+from snap7.types import area
 
 # play with these functions.
 plc.read_area(area['MK'], dbnumber, start, size)

example/example.py

@@ -43,7 +43,7 @@ def get_db_row(db, start, size):
         start (int): The index of where to start in db data
         size (int): The size of the db data to read
     """
-    type_ = snap7.snap7types.wordlen_to_ctypes[snap7.snap7types.S7WLByte]
+    type_ = snap7.types.wordlen_to_ctypes[snap7.types.S7WLByte]
     data = client.db_read(db, start, type_, size)
     # print_row(data[:60])
     return data
@@ -155,7 +155,7 @@ def set_part_db(start, size, _bytearray):
 
 
 def write_data_db(dbnumber, all_data, size):
-    area = snap7.snap7types.S7AreaDB
+    area = snap7.types.S7AreaDB
     dbnumber = 1
     client.write_area(area, dbnumber, 0, size, all_data)
 

example/read_multi.py

@@ -9,7 +9,7 @@
 
 import snap7
 from snap7.common import check_error
-from snap7.snap7types import S7DataItem, S7AreaDB, S7WLByte
+from snap7.types import S7DataItem, S7AreaDB, S7WLByte
 
 
 client = snap7.client.Client()

run_tests.sh

@@ -1,12 +1,11 @@
-#!/bin/sh
+#!/usr/bin/env bash
+
+set -v
+set -e
 
 export PYTHONPATH=.
-echo "Running test_partner.py ----------------------------------------------\n\n"
-sudo nosetests test/test_partner.py
-echo "Running test_server.py  ----------------------------------------------\n\n"
+sudo venv/bin/nosetests test/test_partner.py
 nosetests test/test_server.py
-echo "Running test_client.py  ----------------------------------------------\n\n"
 nosetests test/test_client.py
-echo "Running test_util.py    ----------------------------------------------\n\n"
 nosetests test/test_util.py
 

setup.cfg

@@ -0,0 +1,2 @@
+[pycodestyle]
+ignore = E501,E402,W391,W292,W503