Improve setup and config

* Bump requirements and use only minimum version
* Align Makefile with other projects
* Enable code validation and formatting

Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

Makefile

@@ -1,19 +1,29 @@
-# SPDX-License-Identifier: Apache-2.0
 #
 # Copyright (c) nexB Inc. and others. All rights reserved.
-# ScanCode is a trademark of nexB Inc.
+# FederatedCode is a trademark of nexB Inc.
 # SPDX-License-Identifier: Apache-2.0
-# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
-# See https://github.com/nexB/skeleton for support or download.
-# See https://aboutcode.org for more information about nexB OSS projects.
+# See https://github.com/nexB/federatedcode for support or download.
+# See https://aboutcode.org for more information about AboutCode FOSS projects.
 #
-include .env
+# include .env
 
 # Python version can be specified with `$ PYTHON_EXE=python3.x make conf`
 PYTHON_EXE?=python3
 VENV=venv
+MANAGE=${VENV}/bin/python manage.py
 ACTIVATE?=. ${VENV}/bin/activate;
 MANAGE=${VENV}/bin/python manage.py
+BLACK_ARGS=--exclude=".cache|migrations|data|venv|lib|bin|var|etc"
+# Do not depend on Python to generate the SECRET_KEY
+GET_SECRET_KEY=`base64 /dev/urandom | head -c50`
+# Customize with `$ make envfile ENV_FILE=/etc/federatedcode/.env`
+ENV_FILE=.env
+# Customize with `$ make postgres FEDERATEDCODE_DB_PASSWORD=YOUR_PASSWORD`
+FEDERATEDCODE_DB_NAME=federatedcode
+FEDERATEDCODE_DB_USER=federatedcode
+FEDERATEDCODE_DB_PASSWORD=federatedcode
+POSTGRES_INITDB_ARGS=--encoding=UTF-8 --lc-collate=en_US.UTF-8 --lc-ctype=en_US.UTF-8
+DATE=$(shell date +"%Y-%m-%d_%H%M")
 
 # Use sudo for postgres, but only on Linux
 UNAME := $(shell uname)
@@ -35,55 +45,68 @@ envfile:
 
 isort:
 	@echo "-> Apply isort changes to ensure proper imports ordering"
-	${VENV}/bin/isort --sl -l 100 tests setup.py
+	@${ACTIVATE} isort --profile black .
 
 black:
 	@echo "-> Apply black code formatter"
-	${VENV}/bin/black -l 100 tests setup.py
+	@${ACTIVATE} black ${BLACK_ARGS} .
 
 doc8:
 	@echo "-> Run doc8 validation"
 	@${ACTIVATE} doc8 --max-line-length 100 --ignore-path docs/_build/ --quiet docs/
 
-valid: isort black
+valid: isort black doc8
+
+bandit:
+	@echo "-> Run source code security analyzer"
+	@${ACTIVATE} bandit -r fedcode federatedcode --quiet
 
-check:
-	@echo "-> Run pycodestyle (PEP8) validation"
-	@${ACTIVATE} pycodestyle --max-line-length=100 --exclude=.eggs,venv,lib,thirdparty,docs,migrations,settings.py,.cache .
+check: doc8 bandit
+	@echo "-> Run flake8 (pycodestyle, pyflakes, mccabe) validation"
+	@${ACTIVATE} flake8 .
 	@echo "-> Run isort imports ordering validation"
-	@${ACTIVATE} isort --sl --check-only -l 100 setup.py tests .
+	@${ACTIVATE} isort --profile black --check-only .
 	@echo "-> Run black validation"
-	@${ACTIVATE} black --check --check -l 100 tests setup.py
+	@${ACTIVATE} black --check ${BLACK_ARGS} .
+	@echo "-> Run docstring validation"
+	@${ACTIVATE} pydocstyle fedcode federatedcode
+
+check-deploy:
+	@echo "-> Check Django deployment settings"
+	${MANAGE} check --deploy
 
 clean:
 	@echo "-> Clean the Python env"
 	./configure --clean
 
+migrate:
+	@echo "-> Apply database migrations"
+	${MANAGE} migrate
+
 test:
 	@echo "-> Run the test suite"
-	${VENV}/bin/pytest -vvs
+	@${ACTIVATE} pytest -vvs
 
 docs:
 	rm -rf docs/_build/
 	@${ACTIVATE} sphinx-build docs/source docs/_build/
 
-postgres:
+postgresdb:
 	@echo "-> Configure PostgreSQL database"
-	@echo "-> Create database user '${POSTGRES_DB}'"
-	${SUDO_POSTGRES} createuser --no-createrole --no-superuser --login --inherit --createdb ${POSTGRES_DB} || true
-	${SUDO_POSTGRES} psql -c "alter user ${POSTGRES_USER} with encrypted password '${POSTGRES_PASSWORD}';" || true
-	@echo "-> Drop '${POSTGRES_DB}' database"
-	${SUDO_POSTGRES} dropdb ${POSTGRES_DB} || true
-	@echo "-> Create '${POSTGRES_DB}' database"
-	${SUDO_POSTGRES} createdb --encoding=utf-8 --owner=${POSTGRES_USER} ${POSTGRES_DB}
+	@echo "-> Create database user ${FEDERATEDCODE_DB_NAME}"
+	@${SUDO_POSTGRES} createuser --no-createrole --no-superuser --login --inherit --createdb '${FEDERATEDCODE_DB_USER}' || true
+	@${SUDO_POSTGRES} psql -c "alter user ${FEDERATEDCODE_DB_USER} with encrypted password '${FEDERATEDCODE_DB_PASSWORD}';" || true
+	@echo "-> Drop ${SCANCODEIO_DB_NAME} database"
+	@${SUDO_POSTGRES} dropdb ${FEDERATEDCODE_DB_NAME} || true
+	@echo "-> Create ${FEDERATEDCODE_DB_NAME} database"
+	@${SUDO_POSTGRES} createdb --owner=${FEDERATEDCODE_DB_USER} ${POSTGRES_INITDB_ARGS} ${FEDERATEDCODE_DB_NAME}
 	@$(MAKE) migrate
 
-migrate:
-	@echo "-> Apply database migrations"
-	${MANAGE} migrate
+backupdb:
+	pg_dump -Fc ${FEDERATEDCODE_DB_NAME} > "${FEDERATEDCODE_DB_NAME}-db-${DATE}.dump"
 
 run:
 	@echo "-> Starting development server"
-	${MANAGE} runserver
+	${MANAGE} runserver 8002 --insecure
 
-.PHONY: conf dev check valid black isort clean test docs envfile postgres migrate run
+.PHONY: dev envfile isort black doc8 valid bandit check check-deploy clean migrate test docs  postgresdb backupdb run

requirements-dev.txt

@@ -1,87 +1,11 @@
 aboutcode-toolkit==10.1.0
-alabaster==0.7.13
-anyio==4.1.0
-asgiref==3.7.2
-attrs==23.1.0
-Babel==2.14.0
 black==23.7.0
-boolean.py==4.0
-certifi==2023.5.7
-cffi==1.15.1
-charset-normalizer==3.1.0
-click==8.1.7
-colorama==0.4.6
-cryptography==41.0.1
-dateparser==1.1.8
-Deprecated==1.2.14
-Django==5.0.1
-django-environ==0.11.2
-django-oauth-toolkit==2.3.0
-django-rest-framework==0.1.0
-djangorestframework==3.14.0
-docutils==0.20.1
-et-xmlfile==1.1.0
-exceptiongroup==1.1.1
 execnet==2.0.2
-gitdb==4.0.10
-GitPython==3.1.40
-gunicorn==21.2.0
-h11==0.14.0
-http-message-signatures==0.4.4
-http-sfv==0.9.8
-httpcore==0.17.3
-httpx==0.25.1
-idna==3.4
-imagesize==1.4.1
-importlib-metadata==7.0.1
-iniconfig==2.0.0
 isort==5.12.0
-jaraco.classes==3.3.0
-jeepney==0.8.0
-Jinja2==3.1.2
-jwcrypto==1.5.0
-keyring==24.3.0
-license-expression==30.2.0
-livereload==2.6.3
-markdown-it-py==3.0.0
-MarkupSafe==2.1.3
-mdurl==0.1.2
-more-itertools==10.1.0
-mypy-extensions==1.0.0
-nh3==0.2.15
-oauthlib==3.2.2
-openpyxl==3.1.2
-packageurl-python==0.11.1
-packaging==23.1
-pathspec==0.11.2
-Pillow==9.5.0
-pkginfo==1.9.6
-platformdirs==3.10.0
-pluggy==1.0.0
-psycopg==3.1.16
-psycopg-binary==3.1.16
-psycopg2-binary==2.9.9
-pycodestyle==2.11.1
-pycparser==2.21
-Pygments==2.17.2
 pytest==7.3.2
 pytest-django==4.5.2
 pytest-xdist==3.5.0
 python-dateutil==2.8.2
-pytz==2023.3
-PyYAML==6.0.1
-readme-renderer==42.0
-regex==2023.8.8
-requests==2.31.0
-requests-toolbelt==1.0.0
-rfc3986==2.0.0
-rich==13.7.0
-saneyaml==0.6.0
-SecretStorage==3.3.3
-six==1.16.0
-smmap==5.0.0
-sniffio==1.3.0
-snowballstemmer==2.2.0
 Sphinx==7.2.6
 sphinx-autobuild==2021.3.14
 sphinx-copybutton==0.5.2
@@ -95,13 +19,3 @@ sphinxcontrib-jquery==4.1
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.6
 sphinxcontrib-serializinghtml==1.1.9
-sqlparse==0.4.4
-tomli==2.0.1
-tornado==6.4
-twine==4.0.2
-typing_extensions==4.6.3
-tzlocal==5.0.1
-unidiff==0.7.5
-urllib3==2.0.3
-wrapt==1.15.0
-zipp==3.17.0

requirements.txt

@@ -4,7 +4,6 @@ anyio==4.1.0
 asgiref==3.7.2
 attrs==23.1.0
 Babel==2.14.0
-black==23.7.0
 boolean.py==4.0
 certifi==2023.5.7
 cffi==1.15.1
@@ -64,9 +63,6 @@ psycopg2-binary==2.9.9
 pycodestyle==2.11.1
 pycparser==2.21
 Pygments==2.17.2
-pytest==7.3.2
-pytest-django==4.5.2
-pytest-xdist==3.5.0
 python-dateutil==2.8.2
 pytz==2023.3
 PyYAML==6.0.1
@@ -82,19 +78,6 @@ six==1.16.0
 smmap==5.0.0
 sniffio==1.3.0
 snowballstemmer==2.2.0
-Sphinx==7.2.6
-sphinx-autobuild==2021.3.14
-sphinx-copybutton==0.5.2
-sphinx-reredirects==0.1.3
-sphinx-rtd-dark-mode==1.3.0
-sphinx-rtd-theme==2.0.0
-sphinxcontrib-applehelp==1.0.7
-sphinxcontrib-devhelp==1.0.5
-sphinxcontrib-htmlhelp==2.0.4
-sphinxcontrib-jquery==4.1
-sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-qthelp==1.0.6
-sphinxcontrib-serializinghtml==1.1.9
 sqlparse==0.4.4
 tomli==2.0.1
 tornado==6.4