Adding docs

.github/workflows/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the problem**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Actual behavior**
+A concise description of what happens when you reproduce the behavior.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+OS: e.g. Linux, Windows, macOS
+
+**Additional context**
+Add any other context about the problem here.

.github/workflows/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+**What problem do you want to solve? Please describe.**
+A clear and concise description of what the problem is. Ex. I want to see names of unique listening ports across my organization.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/build.yml

@@ -0,0 +1,46 @@
+# Workflow name
+name: Build
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events for the "main" branch
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v3
+      - name: Install Python Dependencies
+        run: |
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Run linter on Python code files
+        run: |
+          pylint --errors-only --verbose --rcfile=pylintrc user/*.py
+          pylint --errors-only --verbose --rcfile=pylintrc publish/*.py
+          pylint --errors-only --verbose --rcfile=pylintrc search/*.py
+
+#      - name: Run tests and coverage report
+#        run: |       
+#          coverage run --source=src --data-file tests/.coverage -m pytest -s
+#          coverage xml --data-file tests/.coverage -o tests/coverage.xml
+#          coverage report --data-file tests/.coverage -m
+
+#      - name : Send coverage report
+#        run: |
+#          pip install codacy-coverage
+#          export CODACY_PROJECT_TOKEN=${{ secrets.CODACY_PROJECT_TOKEN }}
+#          export CODACY_API_TOKEN=${{ secrets.CODACY_API_TOKEN }}
+#          export CODACY_USERNAME=VSangarya
+#          export CODAY_PROJECT_NAME=AMATSA
+#          python-codacy-coverage -r tests/coverage.xml

.github/workflows/pull_request_template.md

@@ -0,0 +1,3 @@
+# PR template
+*  Give a concise summary and a short description of what changed in files that have beed added/modified.
+*  Link related issues to PR.

.github/workflows/sphinx_autogenerator.yml

@@ -0,0 +1,38 @@
+name: sphinx-autogenerator
+
+on:
+  # Triggers the workflow on push or pull request events for the "main" branch
+  push:
+    branches: ["adding_docs"]
+  pull_request:
+    branches: ["adding_docs"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v2
+            - name: Build documentation and commit
+              run: |
+                  git pull origin adding_docs
+                  python -m pip install --upgrade pip
+                  pip install -r requirements.txt
+                  sudo apt-get install python3-sphinx                
+                  sphinx-apidoc -f -o docs/source PackTravel
+                  sphinx-apidoc -f -o docs/source publish
+                  sphinx-apidoc -f -o docs/source request
+                  sphinx-apidoc -f -o docs/source search
+                  sphinx-apidoc -f -o docs/source user
+                  cd docs/
+                  make html
+                  cd ..
+                  git config --global user.name "qureshi-ali"
+                  git config --global user.email "[email protected]"
+                  git add .
+                  git commit -m "updating docs" -a || true
+                  git push -u origin adding_docs
+        # ===============================

.gitignore

@@ -1,141 +1,6 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-config.ini
-PackTravel/__pycache__/
-*.py[cod]
-*$py.class
+# files
 .DS_Store
-# C extensions
-*.so
-.idea/
 
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
+# directories
 .venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
+__pycache__

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "editor.insertSpaces": true,
+    "editor.tabSize": 4,
+    "python.linting.enabled": true,
+    "python.linting.pylintEnabled": true,
+    "python.linting.pylintArgs": [
+        "--rcfile",
+        "${workspaceFolder}/pylintrc"
+    ]
+}

CONTRIBUTING.md

@@ -13,6 +13,7 @@ The following is a set of guidelines for contributing to PackTravel.
 [How Can I Contribute?](#how-can-i-contribute)
   * [Reporting Bugs](#reporting-bugs)
   * [Suggesting Enhancements](#suggesting-enhancements)
+  * [Style Guides](#style-guides)
   * [Pull Requests](#pull-requests)
 
 
@@ -55,6 +56,8 @@ This section guides you through submitting an enhancement suggestion, including
 * **Drop an [email](mailto:[email protected]) suggesting your change and start writing code.**
 * **Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.**
 
+### Style Guides
+This project uses Python linter to ensure the code style is uniform and conforms to a well known syntactical style: [Pylint analyser](https://pylint.pycqa.org/en/latest/).
 
 ### Pull Requests