Merge branch 'main' into next

Author: actions-user

.flake8

@@ -1,2 +1,7 @@
 [flake8]
-max-line-length = 120
+ignore=D205,D413,D400,D401
+max-line-length=120
+max-complexity=10
+exclude=venv
+extend-exclude="*__init__.py,*__version__.py,venv"
+select="C101"

.pylintrc

@@ -1,8 +1,7 @@
 [MASTER]
 init-hook='import sys; print(sys.executable); print(sys.path)'
-ignore-paths =
-ignore =
-  __version__.py
+ignore-paths=venv
+ignore=__version__.py
 
 [FORMAT]
 max-line-length=120

CHANGELOG.md

@@ -1,9 +1,8 @@
 ## [1.2.1](https://github.com/FullStackWithLawrence/openai-embeddings/compare/v1.2.0...v1.2.1) (2023-12-04)
 
-
 ### Bug Fixes
 
-* force a new release ([e21f9c5](https://github.com/FullStackWithLawrence/openai-embeddings/commit/e21f9c56b6dc3be3320afb88a491b43fc04d365b))
+- force a new release ([e21f9c5](https://github.com/FullStackWithLawrence/openai-embeddings/commit/e21f9c56b6dc3be3320afb88a491b43fc04d365b))
 
 # [1.2.0](https://github.com/lpm0073/hybrid-search-retriever/compare/v1.1.3...v1.2.0) (2023-12-03)
 

Makefile

@@ -1,4 +1,12 @@
 SHELL := /bin/bash
+ifeq ($(OS),Windows_NT)
+    PYTHON = python.exe
+    ACTIVATE_VENV = venv\Scripts\activate
+else
+    PYTHON = python3.11
+    ACTIVATE_VENV = source venv/bin/activate
+endif
+PIP = $(PYTHON) -m pip
 
 ifneq ("$(wildcard .env)","")
     include .env
@@ -25,12 +33,14 @@ all: help
 
 analyze:
 	cloc . --exclude-ext=svg,json,zip --vcs=git
+
 init:
+	make clean && \
+	$(PYTHON) -m venv venv && \
+	$(ACTIVATE_VENV) && \
+	$(PIP) install --upgrade pip && \
+	$(PIP) install -r requirements.txt && \
 	npm install && \
-	python3.11 -m venv venv && \
-	source venv/bin/activate && \
-	pip install --upgrade pip && \
-	pip install -r requirements.txt && \
 	pre-commit install
 
 activate:
@@ -42,10 +52,14 @@ test:
 
 lint:
 	pre-commit run --all-files && \
+	pylint models && \
+	flake8 . && \
+	isort . && \
 	black .
 
 clean:
-	rm -rf venv && rm -rf node_modules
+	rm -rf venv && rm -rf node_modules && \
+	find ./models/ -name __pycache__ -type d -exec rm -rf {} +
 
 release:
 	git commit -m "fix: force a new release" --allow-empty && git push

README.md

@@ -110,6 +110,16 @@ Wharton offers a variety of analytics and accounting courses. Some of the course
 These are just a few examples of the analytics and accounting courses offered at Wharton. The school offers a wide range of courses in these areas to provide students with a comprehensive understanding of financial analysis and decision-making.
 ```
 
+## Requirements
+
+- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). _pre-installed on Linux and macOS_
+- [make](https://gnuwin32.sourceforge.net/packages/make.htm). _pre-installed on Linux and macOS._
+- [OpenAI platform API key](https://platform.openai.com/).
+  _If you're new to OpenAI API then see [How to Get an OpenAI API Key](./doc/OPENAI_API_GETTING_STARTED_GUIDE.md)_
+- [Pinecone](https://www.pinecone.io/) API key.
+- [Python 3.11](https://www.python.org/downloads/): for creating virtual environment used for building AWS Lambda Layer, and locally by pre-commit linters and code formatters.
+- [NodeJS](https://nodejs.org/en/download): used with NPM for local ReactJS developer environment, and for configuring/testing Semantic Release.
+
 ## Configuration defaults
 
 Set these as environment variables on the command line, or in a .env file that should be located in the root of the repo.

models/hybrid_search_retreiver.py

@@ -34,7 +34,7 @@
 # hybrid search capability
 from langchain.retrievers import PineconeHybridSearchRetriever
 from langchain.schema import BaseMessage, HumanMessage, SystemMessage
-from pinecone_text.sparse import BM25Encoder
+from pinecone_text.sparse import BM25Encoder  # pylint: disable=import-error
 
 # this project
 from models.const import Config, Credentials

pyproject.toml

@@ -25,14 +25,6 @@ exclude = '''
 )/
 '''
 
-[tool.flake8]
-ignore = "D205,D413,D400,D401"
-max-line-length =120
-max-complexity = 10
-exclude = "venv"
-extend-exclude = "*__init__.py,*__version__.py,venv"
-select = "C101"
-
 [tool.codespell]
 skip = '*.svg,models/prompt_templates.py'
 ignore-words = 'codespell.txt'