Merge pull request #2 from gwf/gwf-workflows

Gwf workflows

.github/workflows/pylint.yml

@@ -0,0 +1,26 @@
+name: Python application
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install cryptography
+        pip install pylint
+    - name: Run unit tests
+      run: |
+        python -m unittest discover
+    - name: Lint with pylint
+      run: |
+        pylint $(git ls-files '*.py')

.pylintrc

@@ -429,8 +429,8 @@ disable=raw-checker-failed,
         useless-suppression,
         deprecated-pragma,
         use-symbolic-message-instead,
-        use-implicit-booleaness-not-comparison-to-string,
-        use-implicit-booleaness-not-comparison-to-zero
+#        use-implicit-booleaness-not-comparison-to-string,
+#        use-implicit-booleaness-not-comparison-to-zero
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

random_permutation/__init__.py

@@ -1 +1,7 @@
+"""
+This module provides the RandomPermutation class for efficiently
+generating very large random permutations of a given size.  The
+permutations can be varied using the seed parameter and the number of
+ciphers used can be controlled using the num_ciphers parameter.
+"""
 from .permutation import RandomPermutation

setup.py

@@ -1,3 +1,8 @@
+"""
+This setup file is used to package the random_permutation module.
+The module is used for efficiently generating very large random permutations.
+"""
+
 from setuptools import setup, find_packages
 
 setup(

tests/__init__.py

@@ -1 +1 @@
-# This file is intentionally left blank
+# This file is intentionally left blank