diff --git a/.dockerignore b/.dockerignore index d3f10093..6baf3001 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,70 +1,63 @@ -# Build artifacts +# Build Artifacts build/ dist/ *.egg-info/ -# Compiled Python files +# Compiled Python Files *.pyc *.pyo __pycache__/ -# Virtual environment -.venv/ -.env - -# System-specific files -.DS_Store - -# Temporary files -*~ - -# Logging -logs/ -*.log - -# Testing -noxfile.py -.nox/ -.coverage -.coverage.* -coverage.xml -htmlcov/ -tests/ -setup/ -scripts/ +# Documentation and Markdown +CHANGELOG.md +CODE_OF_CONDUCT.md +CONTRIBUTING.md +docs/ +examples/ +mkdocs.yml +site # Git -.github/ .git/ +.github/ .gitignore -# Markdown -CODE_OF_CONDUCT.md -CONTRIBUTING.md -CHANGELOG.md - # Jupyter Notebook .ipynb_checkpoints/ -outputs/ notebooks/ +outputs/ -# VSCode workspace settings -.vscode/ +# Logging +logs/ +*.log -# Python Tools +# Python Tools and Caches .mypy_cache/ .pytest_cache/ .ruff_cache/ -# Mkdocs -.cache -docs/ -examples/ -mkdocs.yml -site +# System-Specific Files +.DS_Store + +# Temporary Files +*~ + +# Testing +*coverage* +.nox/ +.reports/ +scripts/ +setup/ +tests/ +noxfile.py + +# Virtual Environment +.env +.venv/ + +# VSCode Workspace Settings +.vscode/ # Work In Progress (WIP) -readmeai/cli/commands_line.py readmeai/cli/interactive.py -readmeai/config/settings/prompts -readmeai/config/settings/templates +readmeai/config/settings/.conf diff --git a/.gitignore b/.gitignore index f638cebe..ef5c93e9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,53 +1,48 @@ -# Build artifacts +# Build Artifacts +*.egg-info/ build/ dist/ -*.egg-info/ -# Compiled Python files +# Compiled Python Files *.pyc *.pyo __pycache__/ -# Virtual environment -.venv/ -.env - -# System-specific files -.DS_Store - -# Temporary files -*~ - -# Logging -logs/ -*.log - -# Testing -.nox/ -.coverage -.coverage.* -coverage.xml -htmlcov/ +# Documentation and MkDocs +.cache +site # Jupyter Notebook .ipynb_checkpoints/ -outputs/ notebooks/ -# VSCode workspace settings -.vscode/ +# Logging +*.log +logs/ # Python Tools .mypy_cache/ .pytest_cache/ .ruff_cache/ -# Mkdocs -.cache -site +# System-Specific Files +.DS_Store + +# Temporary Files +*~ + +# Testing +.nox/ +.reports/ +*coverage* + +# Virtual Environment +.env +.venv/ + +# VSCode Workspace Settings +.vscode/ # Work In Progress (WIP) -readmeai/cli/commands_line.py readmeai/cli/interactive.py -readmeai/config/settings/prompts -readmeai/config/settings/templates +readmeai/config/settings/.conf diff --git a/.ruff.toml b/.ruff.toml index 0d1c945f..2f436aa1 100644 --- a/.ruff.toml +++ b/.ruff.toml @@ -13,12 +13,15 @@ exclude = [ ] line-length = 79 indent-width = 4 -target-version = "py310" +target-version = "py311" [lint] # Allow unused variables when underscore-prefixed. dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$" -extend-select = ["E501"] +extend-select = [ + "E305", # 2 blank lines before class or function + "E501", +] select = [ "ARG", # unused arguments "B", # flake8-bugbear diff --git a/Makefile b/Makefile index a883d695..3f11ee06 100644 --- a/Makefile +++ b/Makefile @@ -4,12 +4,7 @@ TEST_PATH := tests .PHONY: clean clean: ## Remove project build artifacts - ./scripts/clean.sh clean - -.PHONY: conda-recipe -conda-recipe: ## Create conda recipe for conda-forge - grayskull pypi readmeai - conda build . + ./scripts/clean.sh clean_pyc .PHONY: docker-build docker-build: ## Build Docker image for application @@ -19,8 +14,8 @@ docker-build: ## Build Docker image for application poetry-install: ## Install dependencies using Poetry. poetry install -.PHONY: poetry-remove-environment -poetry-remove-environment: ## Removes Poetry virtual environment and lock file. +.PHONY: poetry-rm-env +poetry-rm-env: ## Removes Poetry virtual environment and lock file. poetry env remove --all && rm poetry.lock .PHONY: poetry-shell @@ -57,8 +52,11 @@ test-nox: ## Run test suite against multiple Python versions nox -f noxfile.py .PHONY: help -help: Makefile ## Display the help menu - @echo -e "" - @echo -e "Usage: make [target]" - @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' - @echo -e "__________________________________________________________________________________________\n" +help: ## Display this help + @echo "" + @echo "Usage: make [target]" + @echo "" + @awk 'BEGIN {FS = ":.*?## "; printf "\033[1m%-20s %-50s\033[0m\n", "Target", "Description"; \ + printf "%-20s %-50s\n", "------", "-----------";} \ + /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-20s\033[0m %-50s\n", $$1, $$2}' $(MAKEFILE_LIST) + @echo "" diff --git a/scripts/clean.sh b/scripts/clean.sh index 17816ee5..fbceb4ea 100755 --- a/scripts/clean.sh +++ b/scripts/clean.sh @@ -33,8 +33,6 @@ function clean_test() { rm -fr .nox/ rm -fr .tox/ rm -fr htmlcov/ - rm .coverage - rm coverage.xml } function clean_backup_and_cache() {