diff --git a/.github/workflows/test_tox.yml b/.github/workflows/test_tox.yml index 90eee37..7326713 100644 --- a/.github/workflows/test_tox.yml +++ b/.github/workflows/test_tox.yml @@ -14,8 +14,6 @@ jobs: strategy: matrix: include: - - python-version: '3.7' - toxenv: 'py37,wheel' - python-version: '3.8' toxenv: 'py38,wheel' - python-version: '3.9' diff --git a/docs/conf.py b/docs/conf.py index 552a006..0fda04e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,6 +52,7 @@ # docstrings. napoleon_google_docstring = True napoleon_numpy_docstring = False +napoleon_include_init_with_doc = True napoleon_include_private_with_doc = False napoleon_include_special_with_doc = True diff --git a/pyproject.toml b/pyproject.toml index 9787c3b..ee74093 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,10 @@ [build-system] requires = ["setuptools", "wheel"] build-backend = "setuptools.build_meta" + +[tool.docformatter] +black = false +non-cap = ["dfDateTime", "dfImageTools", "dfVFS", "dfWinReg", "dtFabric", "iMessage", "iOS", "iPod", "mDNS"] +non-strict = false +wrap-summaries = 80 +wrap-descriptions = 80 diff --git a/setup.cfg b/setup.cfg index 81024a2..c336af3 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = artifactsrc -version = 20240112 +version = 20240220 description = Digital Forensics Artifact knowledge base long_description = Documentation accompanying the Digital Forensics Artifact Repository. long_description_content_type = text/plain @@ -22,7 +22,7 @@ install_requires = file:requirements.txt package_dir = artifactsrc = artifactsrc packages = find: -python_requires = >=3.7 +python_requires = >=3.8 scripts = tools/check_artifacts.py tools/export.py diff --git a/tox.ini b/tox.ini index 3c4744c..33526ee 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py3{7,8,9,10,11,12},coverage,docs,lint,wheel +envlist = py3{8,9,10,11,12},coverage,docformatter,docs,lint,wheel [testenv] allowlist_externals = ./run_tests.py @@ -19,12 +19,19 @@ deps = setuptools >= 65 wheel commands = - py3{7,8,9,10,11,12}: ./run_tests.py + py3{8,9,10,11,12}: ./run_tests.py coverage: coverage erase coverage: coverage run --source=artifactsrc --omit="*_test*,*__init__*,*test_lib*" run_tests.py coverage: coverage xml wheel: python -m build --no-isolation --wheel +[testenv:docformatter] +usedevelop = True +deps = + docformatter +commands = + docformatter --in-place --recursive artifactsrc tests + [testenv:docs] usedevelop = True deps = @@ -45,10 +52,14 @@ setenv = deps = -rrequirements.txt -rtest_requirements.txt + docformatter pylint >= 3.0.0, < 3.1.0 + setuptools yamllint >= 1.26.0 commands = + docformatter --version pylint --version yamllint -v + docformatter --check --diff --recursive artifactsrc setup.py tests tools pylint --rcfile=.pylintrc artifactsrc setup.py tests tools yamllint -c .yamllint.yaml artifactsrc artifactsrc/data