Merge pull request #6 from ramanaditya/develop

package update and docs

.editorconfig

@@ -0,0 +1,36 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini}]
+indent_style = space
+indent_size = 4
+
+[*.py]
+max_line_length = 120
+multi_line_output = 3
+recursive = true
+skip = venv/
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[{Makefile, *.bat}]
+indent_style = tab
+indent_size = 4
+
+[*.bat]
+end_of_line = crlf

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+max-line-length = 120
+exclude = .tox,.git,docs,venv,examples,build,dist,email_service.egg-info
+max-complexity = 18
+ignore = E203

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,11 +17,11 @@ Please delete options that are not relevant.
 
 # Checklist:
 
-- [ ] I have optimized the import, on pycharm it can be done using `ctrl + alt/option + o`
+- [ ] I have optimized the import, on Pycharm it can be done using `ctrl + alt/option + o`
 - [ ] I have used Black for Code Formatting, this enhances code readability.
 - [ ] My code follows the style guidelines of this project
 - [ ] I have performed a self-review of my own code
-- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have commented on my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation
 - [ ] My changes generate no new warnings
 - [ ] I have added tests that prove my fix is effective or that my feature works

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [ "main" ]
+    paths-ignore: [ "docs/**" ]
+
+  push:
+    branches: [ "main" ]
+    paths-ignore: [ "docs/**" ]
+
+
+jobs:
+  flake8:
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Checkout Code Repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Install flake8
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8
+
+      - name: Lint with flake8
+        run: flake8

.github/workflows/python-publish.yml

@@ -29,4 +29,4 @@ jobs:
         TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
       run: |
         python setup.py sdist bdist_wheel
-        twine upload dist/*
+        python -m twine upload dist/*

.readthedocs.yml

@@ -0,0 +1,10 @@
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  version: 3.9
+  install:
+    - requirements: docs/requirements.txt
+    - requirements: requirements.txt