Update project dependencies and settings.

.dockerignore

@@ -36,4 +36,4 @@ mkdocs.yml
 Makefile
 noxfile.py
 readmeai/templates/
-readmeai/markdown/data/badges.json
+readmeai/markdown/data/icons.json

.gitignore

@@ -53,7 +53,7 @@ Pipfile.lock
 
 # Temporarily Ignored
 examples/markdown/readme-edgecase.md
-readmeai/markdown/data/badges.json
+readmeai/markdown/data/icons.json
 readmeai/settings/prompts.toml
 templates/
 .github/workflows/ci.yml

pyproject.toml

@@ -4,38 +4,38 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "readmeai"
-version = "0.4.999"
-description = "🎈 Automated README file generator, powered by large language model APIs"
+version = "0.5.0-beta.2"
+description = "🎈 Automated README file generator, powered by GPT language model APIs."
 authors = ["Eli <[email protected]>"]
 license = "MIT"
 readme = "README.md"
 homepage = "https://github.com/eli64s/readme-ai"
-documentation = "https://github.com/eli64s/readme-ai/blob/main/README.md"
+documentation = "https://eli64s.github.io/readme-ai"
 keywords = [
   "python",
   "markdown",
   "readme",
-  "ai",
   "generator",
   "devtools",
   "documentation",
   "documentation-generator",
   "readme-md",
   "readme-generator",
-  "openai-api",
   "automated-readme",
-  "auto-readme",
   "readme-md-generator",
   "shieldsio-badges",
+  "openai",
+  "vertex-ai",
+  "ai",
+  "llms",
+  "llm-agent",
   "gpt-4",
-  "llm",
   "chatgpt",
-  "gpt-readme"
 ]
 include = ["readmeai", "readmeai.*"]
 
 [tool.poetry.scripts]
-readmeai = "readmeai.cli.commands:commands"
+readmeai = "readmeai.cli.commands:main"
 
 [tool.poetry.dependencies]
 python = "^3.8.1,<4.0.0"
@@ -45,18 +45,18 @@ gitpython = "^3.1.31"
 h2 = "*"
 httpx = "*"
 openai = "^0.27.8"
+pydantic = ">=1.10.9,<2.0.0"
 pyyaml = "^6.0"
 tenacity = "^8.2.2"
 tiktoken = "^0.4.0"
 toml = "^0.10.2"
-pydantic = ">=1.10.9,<2.0.0"
 setuptools = "^69.0.3"
 
 [tool.poetry.group.dev.dependencies]
 ruff = "*"
 
 [tool.poetry.group.test.dependencies]
-pytest = "*"
+pytest = "=7.4.4"
 pytest-asyncio = "*"
 pytest-cov = "*"
 pytest-randomly = "*"
@@ -66,8 +66,13 @@ pytest-xdist = "*"
 [tool.poetry.group.docs.dependencies]
 mkdocs = "*"
 mkdocs-material = "*"
-mkdocstrings = "*"
-mike = "*"
+
+[tool.poetry.group.optional]
+optional = true
+
+[tool.poetry.group.optional.dependencies]
+google-cloud-aiplatform = "^1.40.0"
+# litellm = "^1.20.0"
 
 [tool.ruff]
 exclude = [
@@ -104,20 +109,9 @@ ignore = [
     "E501",  # Line too long
 ]
 
-[tool.isort]
-line_length = 79
-profile = "black"
-multi_line_output = 3
-include_trailing_comma = true
-force_grid_wrap = 0
-use_parentheses = true
-known_third_party = "pytest"
-sections = 'FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER'
-no_lines_before = 'LOCALFOLDER'
-
 [tool.coverage.run]
 source = ["readmeai", "tests"]
-omit = ["tests/*", "*__init__.py", "*/__init__.py", "noxfile.py", "setup.py"]
+omit = ["tests/*", "*__init__.py", "*/__init__.py", "noxfile.py", "readmeai/llms/base.py", "readmeai/llms/factory.py"]
 
 [tool.coverage.report]
 fail_under = 80

setup/environment.yaml

@@ -6,4 +6,4 @@ dependencies:
   - python>=3.9
   - pip
   - pip:
-    - -r ../requirements.txt
+    - -r requirements.txt

setup/requirements.txt

@@ -0,0 +1,49 @@
+aiohttp==3.9.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+aiosignal==1.3.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+anyio==4.2.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+async-timeout==4.0.3 ; python_full_version >= "3.8.1" and python_version < "3.11"
+attrs==23.2.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+certifi==2023.11.17 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+charset-normalizer==3.3.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+click==8.1.7 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+colorama==0.4.6 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0" and (platform_system == "Windows" or sys_platform == "win32")
+colorlog==6.8.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+distro==1.9.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+exceptiongroup==1.2.0 ; python_full_version >= "3.8.1" and python_version < "3.11"
+filelock==3.13.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+frozenlist==1.4.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+fsspec==2023.12.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+gitdb==4.0.11 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+gitpython==3.1.41 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+h11==0.14.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+h2==4.1.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+hpack==4.0.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+httpcore==1.0.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+httpx==0.26.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+huggingface-hub==0.20.3 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+hyperframe==6.0.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+idna==3.6 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+importlib-metadata==7.0.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+jinja2==3.1.3 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+litellm==1.20.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+markupsafe==2.1.4 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+multidict==6.0.4 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+openai==1.10.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+packaging==23.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+pydantic==1.10.14 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+python-dotenv==1.0.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+pyyaml==6.0.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+regex==2023.12.25 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+requests==2.31.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+setuptools==69.0.3 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+smmap==5.0.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+sniffio==1.3.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+tenacity==8.2.3 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+tiktoken==0.4.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+tokenizers==0.15.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+toml==0.10.2 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+tqdm==4.66.1 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+typing-extensions==4.9.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+urllib3==2.1.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+yarl==1.9.4 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"
+zipp==3.17.0 ; python_full_version >= "3.8.1" and python_full_version < "4.0.0"

setup/setup.sh

@@ -100,7 +100,7 @@ export PATH="$(conda info --base)/envs/readmeai/bin:$PATH"
 
 # Install the required packages using pip
 echo "Installing required packages from 'requirements.txt'..."
-pip install -r requirements.txt || {
+pip install -r setup/requirements.txt || {
     echo "Error installing packages from 'requirements.txt'. Aborting."
     conda deactivate
     exit 1