Merge pull request #11 from jaspreetj/master

v0.3.1 update

.github/workflows/CI.yml

@@ -0,0 +1,42 @@
+name: Continuous integration
+
+on: [pull_request, push]
+ #pull_request:
+ #push:
+ #schedule:
+ # - cron: '0 2 * * *' # run at 2 AM UTC
+
+jobs:
+ Lint_and_test_check:
+ runs-on: ubuntu-latest
+ strategy:
+ max-parallel: 1
+ matrix:
+ python-version: [3.8]
+
+ steps:
+ - uses: actions/checkout@v2
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v2
+ with:
+ python-version: ${{ matrix.python-version }}
+ #- name: Install dependencies
+ # run:
+ # python -m pip install --upgrade pip
+ # pip install tox tox-gh-actions
+ # make install
+ #- name: Test with tox
+ # run: tox -e py
+ #- name: Bandit Check
+ # uses: jpetrucciani/[email protected]
+
+ - name: Install flake8
+ run: pip install flake8
+
+ - name: Flake8 Check
+ run: |
+ # stop the build if there are Python syntax errors or undefined names
+ flake8 . --count --select=B,C,E,F,W,T4,B9 --ignore=E203,E266,E501,W503,F403,W605,C901,E722,E731,E741 --show-source --statistics
+ #uses: suo/flake8-github-action@v1
+ #with:
+ # checkName: 'flake8_py3' # NOTE: this needs to be the same as the job name

.pre-commit-config.yaml

@@ -1,25 +1,25 @@
 repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
- rev: ''
+ rev: 'v4.1.0'
  hooks:
  - id: check-yaml
  - id: end-of-file-fixer
  - id: trailing-whitespace
  - repo: https://github.com/hakancelik96/unimport
- rev: stable
+ rev: 0.9.4
  hooks:
  - id: unimport
  args: [--remove, --requirements, --include-star-import]
  - repo: https://github.com/psf/black
- rev: ''
+ rev: '22.1.0'
  hooks:
  - id: black
  - repo: https://gitlab.com/pycqa/flake8
- rev: ''
+ rev: '3.9.2'
  hooks:
  - id: flake8
  - repo: https://github.com/kynan/nbstripout
- rev: master
+ rev: 0.5.0
  hooks:
  - id: nbstripout
  files: '.ipynb'

.readthedocs.yml

@@ -1,24 +1,29 @@
-# .readthedocs.yml
+# .readthedocs.yaml
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 # Required
 version: 2
 
+# Set the version of Python and other tools you might need
+build:
+ os: ubuntu-20.04
+ tools:
+ python: "3.8"
+ # You can also specify other tool versions:
+ # nodejs: "16"
+ # rust: "1.55"
+ # golang: "1.17"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
- configuration: docs/conf.py
-
-# Build documentation with MkDocs
-#mkdocs:
-# configuration: mkdocs.yml
+ configuration: docs/source/conf.py
 
-# Optionally build your docs in additional formats such as PDF
-formats:
- - pdf
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#  - pdf
 
-# Optionally set the version of Python and requirements required to build your docs
+# Optionally declare the Python requirements required to build your docs
 python:
- version: 3.7
- install:
- - requirements: docs/requirements.txt
+ install:
+ - requirements: docs/source/requirements.txt

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020, Jaspreet Jhoja
+Copyright (c) 2022, Jaspreet Jhoja
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal