From ab75034005192904142d285d9d287324e7d4c111 Mon Sep 17 00:00:00 2001 From: simleek Date: Sat, 9 Nov 2019 10:30:11 -0700 Subject: [PATCH] Added initial docs. Loosened tests. --- .travis.yml | 11 ++-- docs/Makefile | 20 +++++++ docs/conf.py | 52 +++++++++++++++++++ docs/index.rst | 20 +++++++ docs/make.bat | 35 +++++++++++++ .../{test_fractal.py => fractal.py} | 0 pyproject.toml | 2 +- tests/effects/test_crop.py | 12 +++-- tests/window/test_subscriber_windows.py | 10 ++-- 9 files changed, 145 insertions(+), 17 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat rename examples/documentation/{test_fractal.py => fractal.py} (100%) diff --git a/.travis.yml b/.travis.yml index e9a355c..eee615b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,14 +7,13 @@ python: - '3.5' - '3.6' - '3.7' +before_install: + - pip install poetry + - pip install tox install: - - pip install -r requirements.txt + - poetry install script: - - if [[ $TRAVIS_PYTHON_VERSION == 3.5 ]]; then export CIBW_BUILD='cp35*'; fi - - if [[ $TRAVIS_PYTHON_VERSION == 3.6 ]]; then export CIBW_BUILD='cp36*'; fi - - if [[ $TRAVIS_PYTHON_VERSION == 3.7 ]]; then export CIBW_BUILD='cp37*'; fi - - pip install cibuildwheel==0.10.1 - - cibuildwheel --output-dir wheelhouse + - poetry build deploy: provider: pypi user: SimLeek diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3e41752 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,52 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'DisplayArray' +copyright = '2019, Simulator Leek' +author = 'Simulator Leek' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..5d82d0c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. DisplayArray documentation master file, created by + sphinx-quickstart on Thu Nov 7 21:13:18 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to DisplayArray's documentation! +======================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..922152e --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/examples/documentation/test_fractal.py b/examples/documentation/fractal.py similarity index 100% rename from examples/documentation/test_fractal.py rename to examples/documentation/fractal.py diff --git a/pyproject.toml b/pyproject.toml index 27464bb..70de0b9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = 'displayarray' -version = '0.0.3' +version = '0.7.0' description = 'Tool for displaying numpy arrays.' authors = ['SimLeek '] license = 'MIT' diff --git a/tests/effects/test_crop.py b/tests/effects/test_crop.py index dd46271..108dcde 100644 --- a/tests/effects/test_crop.py +++ b/tests/effects/test_crop.py @@ -7,7 +7,7 @@ import mock def test_init_defaults(): c = crop.Crop() - assert c.output_size == (64, 64, 3) + assert np.all(c.output_size == (64, 64, 3)) assert c.center is None assert c.odd_center is None assert c.input_size is None @@ -16,10 +16,12 @@ def test_init_defaults(): def test_init(): c = crop.Crop((32, 32, 3), (16, 16, 1)) - assert c.output_size == (32, 32, 3) - assert c.center == (16, 16, 1) - assert c.odd_center == [0, 0, 1] - assert c.input_size is None + c(np.ndarray((64,64,3))) + + assert np.all(c.output_size == (32, 32, 3)) + assert np.all(c.center == (16, 16, 1)) + assert np.all(c.odd_center == [0, 0, 1]) + assert c.input_size == (64, 64, 3) def test_1d_crop(): diff --git a/tests/window/test_subscriber_windows.py b/tests/window/test_subscriber_windows.py index 68a0686..b8c1836 100644 --- a/tests/window/test_subscriber_windows.py +++ b/tests/window/test_subscriber_windows.py @@ -160,8 +160,8 @@ def test_handle_keys(): mock_destroy.assert_called_once_with("displayarray (press ESC to quit)") assert sw.exited is True - mock_win_cmd.quit.assert_called_once() - mock_stop.assert_called_once_with("0") + mock_win_cmd.quit.assert_called() + mock_stop.assert_called_with("0") assert ret == "quit" @@ -422,8 +422,8 @@ def test_end(): sw.end() - mock_win_cmd.quit.assert_called_once_with(force_all_read=False) - mock_stop.assert_called_once_with("0") + mock_win_cmd.quit.assert_called_with(force_all_read=False) + mock_stop.assert_called_with("0") sw.close_threads[0].join.assert_called_once() sw.close_threads[1].join.assert_called_once() @@ -436,7 +436,7 @@ def test_enter_exit(): with sub_win.SubscriberWindows() as sw: assert isinstance(sw, sub_win.SubscriberWindows) - end.assert_called_once() + end.assert_called() def test_del():