Merge pull request #208 from byuccl/next_release

SpyDrNet 1.13.0

.github/workflows/pylint.yml

@@ -4,7 +4,7 @@ on: [push]
 
 jobs:
   build:
-    if: github.ref == 'refs/heads/master'
+    # if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -22,4 +22,4 @@ jobs:
         pip install pylint-exit
     - name: Analysing the code with pylint
       run: |
-        pylint --rcfile=.pylintrc spydrnet/ || pylint-exit $?        
+        pylint --rcfile=.pylintrc spydrnet/ || pylint-exit --error-fail $?        

.github/workflows/pytest.yml

@@ -14,13 +14,17 @@ jobs:
           - "3.8"
           - "3.9"
           - "3.10"
+    env:
+      EXAMPLE_NETLISTS_PATH: ${{ github.workspace }}/example_netlists/
     steps:
     - uses: actions/checkout@master
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Install Dependencies
+      run: |
+        python -m pip install requests pytest
     - name: Run Pytest for SpyDrNet
-      uses: cclauss/GitHub-Action-for-pytest@master
-      with:
-        args: python -m pytest -v
+      run: |
+        python3 -m pytest -v

.pylintrc

@@ -23,26 +23,26 @@ extension-pkg-whitelist=
 fail-on=
 
 # Specify a score threshold to be exceeded before program exits with error.
-fail-under=6.0
+fail-under=8.3
 
 # Files or directories to be skipped. They should be base names, not paths.
 ignore=CVS
 
 # Add files or directories matching the regex patterns to the ignore-list. The
 # regex matches against paths.
-ignore-paths=
+ignore-paths= spydrnet/parsers/primatives/parsetab.py
 
 # Files or directories matching the regex patterns are skipped. The regex
 # matches against base names, not paths.
-ignore-patterns= parsetab.py
+ignore-patterns=
 
 # Python code to execute, usually for sys.path manipulation such as
 # pygtk.require().
 #init-hook=
 
 # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
 # number of processors available to use.
-jobs=0
+jobs=1
 
 # Control the amount of potential inferred values when inferring a single
 # object. This can help the performance when dealing with large functions or
@@ -80,16 +80,17 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
-disable=print-statement,
-        parameter-unpacking,
-        unpacking-in-except,
-        old-raise-syntax,
-        backtick,
-        long-suffix,
-        old-ne-operator,
-        old-octal-literal,
-        import-star-module-level,
-        non-ascii-bytes-literal,
+disable=
+#         print-statement,
+#         parameter-unpacking,
+#         unpacking-in-except,
+#         old-raise-syntax,
+#         backtick,
+#         long-suffix,
+#         old-ne-operator,
+#         old-octal-literal,
+#         import-star-module-level,
+#         non-ascii-bytes-literal,
         raw-checker-failed,
         bad-inline-option,
         locally-disabled,
@@ -98,67 +99,67 @@ disable=print-statement,
         useless-suppression,
         deprecated-pragma,
         use-symbolic-message-instead,
-        apply-builtin,
-        basestring-builtin,
-        buffer-builtin,
-        cmp-builtin,
-        coerce-builtin,
-        execfile-builtin,
-        file-builtin,
-        long-builtin,
-        raw_input-builtin,
-        reduce-builtin,
-        standarderror-builtin,
-        unicode-builtin,
-        xrange-builtin,
-        coerce-method,
-        delslice-method,
-        getslice-method,
-        setslice-method,
-        no-absolute-import,
-        old-division,
-        dict-iter-method,
-        dict-view-method,
-        next-method-called,
-        metaclass-assignment,
-        indexing-exception,
-        raising-string,
-        reload-builtin,
-        oct-method,
-        hex-method,
-        nonzero-method,
-        cmp-method,
-        input-builtin,
-        round-builtin,
-        intern-builtin,
-        unichr-builtin,
-        map-builtin-not-iterating,
-        zip-builtin-not-iterating,
-        range-builtin-not-iterating,
-        filter-builtin-not-iterating,
-        using-cmp-argument,
-        eq-without-hash,
-        div-method,
-        idiv-method,
-        rdiv-method,
-        exception-message-attribute,
-        invalid-str-codec,
-        sys-max-int,
-        bad-python3-import,
-        deprecated-string-function,
-        deprecated-str-translate-call,
-        deprecated-itertools-function,
-        deprecated-types-field,
-        next-method-defined,
-        dict-items-not-iterating,
-        dict-keys-not-iterating,
-        dict-values-not-iterating,
-        deprecated-operator-function,
-        deprecated-urllib-function,
-        xreadlines-attribute,
-        deprecated-sys-function,
-        exception-escape,
-        comprehension-escape
+#         apply-builtin,
+#         basestring-builtin,
+#         buffer-builtin,
+#         cmp-builtin,
+#         coerce-builtin,
+#         execfile-builtin,
+#         file-builtin,
+#         long-builtin,
+#         raw_input-builtin,
+#         reduce-builtin,
+#         standarderror-builtin,
+#         unicode-builtin,
+#         xrange-builtin,
+#         coerce-method,
+#         delslice-method,
+#         getslice-method,
+#         setslice-method,
+#         no-absolute-import,
+#         old-division,
+#         dict-iter-method,
+#         dict-view-method,
+#         next-method-called,
+#         metaclass-assignment,
+#         indexing-exception,
+#         raising-string,
+#         reload-builtin,
+#         oct-method,
+#         hex-method,
+#         nonzero-method,
+#         cmp-method,
+#         input-builtin,
+#         round-builtin,
+#         intern-builtin,
+#         unichr-builtin,
+#         map-builtin-not-iterating,
+#         zip-builtin-not-iterating,
+#         range-builtin-not-iterating,
+#         filter-builtin-not-iterating,
+#         using-cmp-argument,
+#         eq-without-hash,
+#         div-method,
+#         idiv-method,
+#         rdiv-method,
+#         exception-message-attribute,
+#         invalid-str-codec,
+#         sys-max-int,
+#         bad-python3-import,
+#         deprecated-string-function,
+#         deprecated-str-translate-call,
+#         deprecated-itertools-function,
+#         deprecated-types-field,
+#         next-method-defined,
+#         dict-items-not-iterating,
+#         dict-keys-not-iterating,
+#         dict-values-not-iterating,
+#         deprecated-operator-function,
+#         deprecated-urllib-function,
+#         xreadlines-attribute,
+#         deprecated-sys-function,
+#         exception-escape,
+#         comprehension-escape
 
 # 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

README.rst

@@ -24,7 +24,7 @@ SpyDrNet can be used to create netlists from scratch. Because it is a low-level
 
 **Loading Example Netlists**
 
-Several example netlists are included with the package to introduce the framework, its features, and functionality. To list and load these netlists, modify the following example: 
+Several example netlists are included in the repository to introduce the framework, its features, and functionality. To list and load these netlists, see the :ref:`using_example_netlists` page and then run the following: 
 
 .. code:: python
 

RELEASE.rst

@@ -1,9 +1,20 @@
+SpyDrNet 1.13.0
+----------------
+August 14, 2023
+
+* Moved the example netlists and tests out of the python package and added documentation how to use the example netlists
+* Updated to use pathlib instead of os
+* Added Github actions check to run Pylint and to fail if score is too low
+* Added documentation about Pylint and code formatting
+* Various minor improvements
+* Other small edits to documentation
+
 SpyDrNet 1.12.2
 ----------------
 April 18, 2023
 
-Bug fix for Verilog parser for partially connected ports being misaligned and fixed primitive name with a space at the end.
-Changed some of the os.path to pathlib to conform to updated coding standards
+* Bug fix for Verilog parser for partially connected ports being misaligned and fixed primitive name with a space at the end.
+* Changed some of the os.path to pathlib to conform to updated coding standards
 
 SpyDrNet 1.12.1
 ----------------