Merge pull request #84 from eli64s/refactor/reduce-package-dependencies

Core Logic and Dependency Optimizations

Author: eli64s

Makefile

@@ -3,34 +3,35 @@
 SHELL := /bin/bash
 VENV := readmeai
 
-.PHONY: help clean format lint conda-recipe git-rm-cache test poetry-reqs word-search
+.PHONY: help clean format lint conda-recipe git-rm-cache nox pytest poetry-reqs word-search
 
 help:
 	@echo "Commands:"
 	@echo "clean        : repository file cleanup."
 	@echo "format       : executes code formatting."
 	@echo "lint         : executes code linting."
-	@echo "conda-recipe  : builds conda package."
+	@echo "conda-recipe : builds conda package."
 	@echo "git-rm-cache : fix git untracked files."
-	@echo "test         : executes tests."
+	@echo "nox          : executes nox test suite."
+	@echo "pytest       : executes tests."
 	@echo "poetry-reqs  : generates requirements.txt file."
 	@echo "word-search  : searches for a word in the repository."
 
 .PHONY: clean
 clean: format
+	@echo -e "\nFile clean up in directory: ${CURDIR}"
 	./scripts/clean.sh clean
 
 .PHONY: format
 format:
 	@echo -e "\nFormatting in directory: ${CURDIR}"
-	black ${CURDIR}
-	isort ${CURDIR}
+	ruff check --select I --fix .
+	ruff format .
 
 .PHONY: lint
 lint:
 	@echo -e "\nLinting in directory: ${CURDIR}"
-	flake8 ${CURDIR}
-	ruff ${CURDIR}
+	ruff check . --fix
 
 .PHONY: conda-recipe
 conda-recipe:
@@ -41,8 +42,12 @@ conda-recipe:
 git-rm-cache:
 	git rm -r --cached .
 
-.PHONY: test
-test:
+.PHONY: nox
+nox:
+	nox -f noxfile.py
+
+.PHONY: pytest
+pytest:
 	pytest \
 	-n auto \
 	--cov=./ \

README.md

@@ -431,7 +431,7 @@ poetry run python3 -m readmeai.cli.commands -o readme-ai.md -r https://github.co
 
 Use [`pytest`](https://docs.pytest.org/en/7.1.x/contents.html) to run the default test suite.
 ```sh
-make test
+make pytest
 ```
 
 Use [`nox`](https://nox.thea.codes/en/stable/) to run the test suite against multiple Python versions including `(3.9, 3.10, 3.11, 3.12)`.

poetry.lock

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "readmeai"
-version = "0.4.992"
+version = "0.4.993"
 description = "🎈 Automated README file generator, powered by GPT language model APIs"
 authors = ["Eli <0x.eli.64s@gmail.com>"]
 license = "MIT"
@@ -39,59 +39,68 @@ readmeai = "readmeai.cli.commands:commands"
 
 [tool.poetry.dependencies]
 python = "^3.8.1,<4.0.0"
-aiohttp = "^3.8.5"
-cachetools = "^5.3.1"
+aiohttp = "*"
 click = "^8.1.7"
 colorlog = "^6.7.0"
 gitpython = "^3.1.31"
-httpx = "^0.24.1"
-h2 = "^4.1.0"
 openai = "^0.27.8"
 pyyaml = "^6.0"
-tabulate = "^0.9.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.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
+ruff = "*"
+
+[tool.poetry.group.test.dependencies]
 pytest = "*"
 pytest-asyncio = "*"
 pytest-cov = "*"
 pytest-randomly = "*"
 pytest-sugar = "*"
 pytest-xdist = "*"
-ruff = "*"
 
 [tool.poetry.group.docs.dependencies]
 mkdocs = "*"
 mkdocs-material = "*"
 
-[tool.black]
+
+[tool.ruff]
+exclude = [
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pytest_cache",
+    ".ruff_cache",
+    ".vscode",
+]
 line-length = 79
-include = '\.pyi?$'
-exclude = '''
-/(
-      .eggs
-    | .git
-    | .hg
-    | .mypy_cache
-    | .tox
-    | venv
-    | _build
-    | buck-out
-    | build
-    | dist
-    | notebooks
-  )/
-'''
-virtual_env = "poetry"
 
-[tool.flake8]
-max-line-length = 79
-extend-ignore = ["E203", "W503"]
-exclude = ".venv,.git,.nox,docs,venv,bin,lib,deps,build,tests,examples,notebooks"
+[tool.ruff.format]
+quote-style = "double"
+docstring-code-format = true
+docstring-code-line-length = 20
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+]
+ignore = [
+    "E501",  # Line too long
+]
 
 [tool.isort]
 line_length = 79

pyproject.toml

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import os
-from typing import Optional
 
 import click
 from click import Context, Parameter
@@ -12,26 +11,11 @@
 
 
 def prompt_for_custom_image(
-    context: Optional[Context],
-    parameter: Optional[Parameter],
-    value: Optional[str],
+    context: Context | None,
+    parameter: Parameter | None,
+    value: str | None,
 ) -> str:
-    """Prompts the user to input a custom image URL.
-
-    Parameters
-    ----------
-    ctx
-        Click context object.
-    param
-        Click parameter object.
-    value
-        Value of the parameter.
-
-    Returns
-    -------
-    str
-        Custom image URL.
-    """
+    """Prompt the user for a custom image URL."""
     if value == ImageOptions.CUSTOM.name:
         return click.prompt("Enter the URL for your custom image logo")
     elif value in ImageOptions.__members__: