move black dependency to an extra (#449)

Author: mr-c

.github/workflows/ci-tests.yml

@@ -87,7 +87,7 @@ jobs:
             source .env/bin/activate && \
             python -m pip install --upgrade pip wheel setuptools && \
             python -m pip install -r mypy-requirements.txt -r requirements.txt && \
-            MYPYPATH=typeshed SCHEMA_SALAD_USE_MYPYC=1 pip install -e . && \
+            MYPYPATH=typeshed SCHEMA_SALAD_USE_MYPYC=1 pip install -e .[pycodegen] && \
             deactivate'
     - name: Test with pytest
       run: |
@@ -96,7 +96,7 @@ jobs:
             bash -exc '\
             source .env/bin/activate && \
             pip install setuptools wheel -r test-requirements.txt && \
-            make mypyc
+            make test
             deactivate'
 
   tox-style:

Makefile

@@ -22,6 +22,7 @@
 
 MODULE=schema_salad
 PACKAGE=schema-salad
+EXTRAS=[pycodegen]
 
 # `SHELL=bash` doesn't work for some, so don't use BASH-isms like
 # `[[` conditional expressions.
@@ -52,11 +53,11 @@ install-dependencies: FORCE
 
 ## install     : install the ${MODULE} module and schema-salad-tool
 install: FORCE
-	pip install .
+	pip install .$(EXTRAS)
 
 ## dev     : install the ${MODULE} module in dev mode
 dev: install-dep
-	pip install -e .
+	pip install -e .$(EXTRAS)
 
 ## dist        : create a module package for distribution
 dist: dist/${MODULE}-$(VERSION).tar.gz

README.rst

@@ -22,34 +22,42 @@ Web.
 
 The Schema Salad library is Python 3.6+ only.
 
-Usage
------
+Installation
+------------
 
 ::
 
-   $ pip install schema_salad
+   pip3 install schema_salad
+
+If you intend to use the `schema-salad-tool --codegen=python` feature, please
+include the `[pycodegen]` extra::
+
+   pip3 install schema_salad[pycodegen]
 
 To install from source::
 
-  git clone https://github.com/common-workflow-language/schema_salad
-  cd schema_salad
-  python3 setup.py install
+   git clone https://github.com/common-workflow-language/schema_salad
+   cd schema_salad
+   pip3 install .
+   # or pip3 install .[pycodegen] if needed
 
 Commands
 --------
 
 Schema salad can be used as a command line tool or imported as a Python module::
 
    $ schema-salad-tool
-   usage: schema-salad-tool [-h] [--rdf-serializer RDF_SERIALIZER]
-                         [--print-jsonld-context | --print-rdfs | --print-avro
-                         | --print-rdf | --print-pre | --print-index
-                         | --print-metadata | --print-inheritance-dot
-                         | --print-fieldrefs-dot | --codegen language
-                         | --print-oneline]
-                         [--strict | --non-strict] [--verbose | --quiet
-                         | --debug]
-                         [--version]
+   usage: schema-salad-tool [-h] [--rdf-serializer RDF_SERIALIZER] [--skip-schemas]
+                         [--strict-foreign-properties] [--print-jsonld-context]
+                         [--print-rdfs] [--print-avro] [--print-rdf] [--print-pre]
+                         [--print-index] [--print-metadata] [--print-inheritance-dot]
+                         [--print-fieldrefs-dot] [--codegen language] [--codegen-target CODEGEN_TARGET]
+                         [--codegen-examples directory] [--codegen-package dotted.package]
+                         [--codegen-copyright copyright_string] [--print-oneline]
+                         [--print-doc] [--strict | --non-strict]
+                         [--verbose | --quiet | --debug] [--only ONLY] [--redirect REDIRECT]
+                         [--brand BRAND] [--brandlink BRANDLINK] [--brandstyle BRANDSTYLE]
+                         [--brandinverse] [--primtype PRIMTYPE] [--version]
                          [schema] [document]
 
    $ python
@@ -75,7 +83,8 @@ Convert a document to JSON-LD::
 
    $ schema-salad-tool --print-pre myschema.yml mydocument.yml > mydocument.jsonld
 
-Generate Python classes for loading/generating documents described by the schema::
+Generate Python classes for loading/generating documents described by the schema
+(Requires the `[pycodegen]` extra)::
 
    $ schema-salad-tool --codegen=python myschema.yml > myschema.py
 

release-test.sh

@@ -7,6 +7,7 @@ export LC_ALL=C
 
 package=schema-salad
 module=schema_salad
+extras="[pycodegen]"
 
 if [ "$GITHUB_ACTIONS" = "true" ]; then
     # We are running as a GH Action
@@ -34,7 +35,7 @@ then
 	rm -f testenv1/lib/python-wheels/setuptools* \
 		&& pip install --force-reinstall -U pip==${pipver} \
 		&& pip install setuptools==${setuptoolsver} wheel
-	pip install -rtest-requirements.txt .
+	pip install -rtest-requirements.txt ".${extras}"
 	make test
 	pip uninstall -y ${package} || true; pip uninstall -y ${package} || true; make install
 	mkdir testenv1/not-${module}
@@ -60,7 +61,7 @@ rm -f lib/python-wheels/setuptools* \
 	&& pip install --force-reinstall -U pip==${pipver} \
         && pip install setuptools==${setuptoolsver} wheel
 # The following can fail if you haven't pushed your commits to ${repo}
-pip install -e "git+${repo}@${HEAD}#egg=${package}"
+pip install -e "git+${repo}@${HEAD}#egg=${package}${extras}"
 pushd src/${package}
 pip install -rtest-requirements.txt
 make dist
@@ -84,7 +85,7 @@ rm -f lib/python-wheels/setuptools* \
         && pip install setuptools==${setuptoolsver} wheel
 package_tar=$(find . -name "${package}*tar.gz")
 pip install "-r${DIR}/test-requirements.txt"
-pip install "${package_tar}"
+pip install "${package_tar}${extras}"
 mkdir out
 tar --extract --directory=out -z -f ${package}*.tar.gz
 pushd out/${package}*
@@ -108,7 +109,7 @@ source bin/activate
 rm -f lib/python-wheels/setuptools* \
 	&& pip install --force-reinstall -U pip==${pipver} \
         && pip install setuptools==${setuptoolsver} wheel
-pip install ${module}*.whl
+pip install "$(ls ${module}*.whl)${extras}"
 pip install "-r${DIR}/test-requirements.txt"
 mkdir not-${module}
 pushd not-${module}

schema_salad/python_codegen_support.py

@@ -1,4 +1,4 @@
-"""Template code used by python_codgen.py."""
+"""Template code used by python_codegen.py."""
 import copy
 import os
 import pathlib

setup.py

@@ -82,11 +82,11 @@
     "mistune >= 0.8.1, < 0.9",
     "CacheControl >= 0.11.7, < 0.13",
     "lockfile >= 0.9",  # needed for CacheControl's FileCache
-    "black",
 ]
 
 extras_require = {
     "docs": ["sphinx >= 2.2", "sphinx-rtd-theme", "pytest < 7"],
+    "pycodegen": ["black"],
 }
 
 setup(

tox.ini

@@ -7,7 +7,6 @@ envlist =
   py39-lint-readme,
   py39-pydocstyle
 
-skipsdist = True
 skip_missing_interpreters = True
 
 [pytest]
@@ -35,7 +34,7 @@ passenv =
   CI
   GITHUB_*
 deps =
-  py{36,37,38,39,310}-{unit,lint,bandit,mypy}: -rrequirements.txt
+  py{36,37,38,39,310}-{unit,mypy}: -rrequirements.txt
   py{36,37,38,39,310}-{unit,mypy}: -rtest-requirements.txt
   py{36,37,38,39,310}-lint: flake8-bugbear
   py{36,37,38,39,310}-lint: black
@@ -59,12 +58,20 @@ whitelist_externals =
   py{36,37,38,39,310}-lint: black
   py{36,37,38,39,310}-{mypy,shellcheck,lint,unit}: make
 
+skip_install =
+  py{36,37,38,39,310}-lint: true
+  py{36,37,38,39,310}-bandit: true
+
+extras =
+  py{36,37,38,39,310}-unit: pycodegen
+
 [testenv:py39-pydocstyle]
 whitelist_externals = make
 commands = make diff_pydocstyle_report
 deps =
     pydocstyle
     diff-cover
+skip_install = true
 
 [testenv:py39-lint-readme]
 commands =
@@ -75,3 +82,4 @@ deps =
     twine
     wheel
     readme_renderer[md]
+skip_install = true