Merge pull request #19 from surapuramakhil-org/release/v0.1.0

release v0.1.0-beta

.actrc

@@ -0,0 +1,2 @@
+#set this value as per your PC architecture
+--container-architecture linux/arm64

.env.template

@@ -0,0 +1,5 @@
+# refer to docs: [getting_web_search_engine_creds.md](docs/getting_web_search_engine_creds.md)
+GOOGLE_API_KEY=
+GOOGLE_SEARCH_ENGINE_ID=
+BING_API_KEY=
+BRAVE_API_KEY=

.github/FUNDING.yml

@@ -1 +1,2 @@
-
+custom:
+  - https://giveth.io/project/job_hunt_assistant

.github/workflows/cla.yml

@@ -0,0 +1,44 @@
+name: "CLA Assistant"
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened,closed,synchronize]
+
+# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
+permissions:
+  actions: write
+  contents: write # this can be 'read' if the signatures are in remote repository
+  pull-requests: write
+  statuses: write
+
+jobs:
+  CLAAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Assistant"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # the below token should have repo scope and must be manually added by you in the repository's secret
+          # This token is required only if you have configured to store the signatures in a remote repository/organization
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_RECORDS_PAT }}
+        with:
+          path-to-signatures: 'signatures/version1/cla.json'
+          path-to-document: 'https://github.com/surapuramakhil-org/cla-records/blob/main/cla.md' # e.g. a CLA or a DCO document
+          # branch should not be protected
+          branch: 'main'
+          allowlist: |
+            surapuramakhil,
+            bot*
+
+          remote-organization-name: surapuramakhil-org
+          remote-repository-name: cla-records
+          create-file-commit-message: 'Creating CLA Signatures file in cla-records repository'
+          signed-commit-message: '$contributorName has signed the CLA in $owner/$repo#$pullRequestNo'
+          custom-notsigned-prcomment: 'Thank you for your contribution! Please sign the CLA by commenting: "I have read the CLA Document and I hereby sign the CLA."'
+          custom-pr-sign-comment: 'I have read the CLA Document and I hereby sign the CLA.'
+          custom-allsigned-prcomment: '**CLA Assistant Lite bot**: All contributors have signed the CLA. Thank you!'
+          lock-pullrequest-aftermerge: false
+          use-dco-flag: false

.github/workflows/py_test.yml

@@ -0,0 +1,22 @@
+name: Python Test Suite
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  unit_tests:
+    name: Unit Tests
+    uses: ./.github/workflows/test_env_setup_and_run_workflow.yml # Calls reusable workflow for setup and test execution
+    with:
+      test_command: poetry run pytest tests/unit # Passes unit test command as input
+
+  integration_tests:
+    name: Integration Tests
+    uses: ./.github/workflows/test_env_setup_and_run_workflow.yml # Calls reusable workflow for setup and test execution
+    with:
+      test_command: poetry run pytest tests/integration # Passes integration test command as input

.github/workflows/test_env_setup_and_run_workflow.yml

@@ -0,0 +1,43 @@
+name: Test Environment Setup and Run Workflow
+
+on:
+  workflow_call:
+    inputs:
+      test_command:
+        description: "The command to run tests"
+        required: true
+        type: string
+
+jobs:
+  setup_and_test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.13'
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          export PATH="$HOME/.local/bin:$PATH"
+
+      - name: Set PYTHONPATH for src directory
+        run: |
+          echo "PYTHONPATH=$PWD/src" >> $GITHUB_ENV
+          echo "PYTHONPATH set to $PWD/src"
+
+      - name: Install dependencies (with dev)
+        run: poetry install --with dev
+
+      - name: Debug PYTHONPATH
+        run: echo $PYTHONPATH # Print PYTHONPATH to verify it's set correctly
+
+      - name: Run tests with PyTest configuration
+        env:
+          PYTHONPATH: ${{ env.PYTHONPATH }} # Explicitly pass PYTHONPATH to the test environment
+        run: ${{ inputs.test_command }}

.gitignore

@@ -145,7 +145,10 @@ venv.bak/
 *.iml
 
 # Visual Studio Code
-.vscode/
+.vscode/*
+!.vscode/settings.json
+!.vscode/extensions.json
+!.vscode/launch.json
 
 # Visual Studio 2015/2017/2019/2022
 .vs/

.pylintrc

@@ -0,0 +1,3 @@
+[MASTER]
+init-hook='import sys; sys.path.append("${workspaceFolder}/src")'
+ignore=lib

.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+    "configurations": [
+        {
+            "type": "debugpy",
+            "request": "launch",
+            "name": "Launch Program",
+            "program": "${workspaceFolder}/src/main.py",
+            "args": [],
+            "console": "integratedTerminal",
+            "justMyCode": false
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv",
+    "python.analysis.extraPaths": [
+        "${workspaceFolder}/src",
+        "${workspaceFolder}"
+    ],
+    "python.analysis.autoImportCompletions": true,
+    "python.analysis.indexing": true,
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+}