From e4c1d39247c801b415edda6e290a0f6a31b19dff Mon Sep 17 00:00:00 2001 From: Benedikt Moneke <67148916+bmoneke@users.noreply.github.com> Date: Wed, 12 Jul 2023 14:35:03 +0200 Subject: [PATCH] First version for CI, similar to pymeasure. --- .github/pytest.json | 23 +++ .github/sphinx.json | 38 +++++ .github/workflows/pyleco_CI.yml | 105 ++++++++++++++ docs/Makefile | 177 +++++++++++++++++++++++ docs/index.rst | 3 + docs/make.bat | 242 ++++++++++++++++++++++++++++++++ environment.yml | 16 ++- pyleco/__init__.py | 51 +++++++ pyproject.toml | 14 +- setup.cfg | 6 + 10 files changed, 665 insertions(+), 10 deletions(-) create mode 100644 .github/pytest.json create mode 100644 .github/sphinx.json create mode 100644 .github/workflows/pyleco_CI.yml create mode 100644 docs/Makefile create mode 100644 docs/index.rst create mode 100644 docs/make.bat create mode 100644 setup.cfg diff --git a/.github/pytest.json b/.github/pytest.json new file mode 100644 index 000000000..7f010d1e9 --- /dev/null +++ b/.github/pytest.json @@ -0,0 +1,23 @@ +{ + "problemMatcher": [ + { + "owner": "pytest-warnings", + "severity": "warning", + "pattern": [ + { + "regexp": "^=+ warnings summary =+$" + }, + { + "regexp": "^(?.+?):(?\\d+)$", + "file": 1, + "line": 2 + }, + { + "regexp": "^ (?.+)$", + "message": 1, + "loop": true + } + ] + } + ] +} diff --git a/.github/sphinx.json b/.github/sphinx.json new file mode 100644 index 000000000..2f12378da --- /dev/null +++ b/.github/sphinx.json @@ -0,0 +1,38 @@ +{ + "problemMatcher": [ + { + "owner": "sphinx-docstring", + "pattern": [ + { + "regexp": "^(?.+?):(?.*? (?WARNING|ERROR): .+)$", + "file": 1, + "severity": 3, + "message": 2 + } + ] + }, + { + "owner": "sphinx-doctest", + "pattern": [ + { + "regexp": "^File \\\"(?.+?)\\\", line (?\\d+|\\?), (?.*$)", + "file": 1, + "line": 2, + "message": 3 + } + ] + }, + { + "owner": "sphinx-extension", + "pattern": [ + { + "regexp": "^(?WARNING|ERROR): (?\\S+): (?.+)(?)$", + "severity": 1, + "code": 2, + "message": 3, + "file": 4 + } + ] + } + ] +} diff --git a/.github/workflows/pyleco_CI.yml b/.github/workflows/pyleco_CI.yml new file mode 100644 index 000000000..b7a575caa --- /dev/null +++ b/.github/workflows/pyleco_CI.yml @@ -0,0 +1,105 @@ +name: PyLECO CI +on: + push: + branches: + - main + pull_request: + +jobs: + docs_lint: + name: Docs and Linting + runs-on: "ubuntu-latest" + defaults: + run: + shell: bash -l {0} + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Cache conda + uses: actions/cache@v3 + env: + CACHE_NUMBER: 0 # Increase to reset the cache + with: + path: ~/conda_pkgs_dir + key: py3.10-ubuntu-latest-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('environment.yml') }} + - name: Install pyleco requirements + uses: conda-incubator/setup-miniconda@v2 + with: + python-version: "3.10" + environment-file: environment.yml + activate-environment: pyleco + auto-update-conda: true + use-only-tar-bz2: true # for caching to work properly + - name: Conda info & list + run: | + conda info + conda list + - name: Set up flake8 annotations + uses: rbialon/flake8-annotations@v1 + - name: Lint with flake8 + run: | + # Be sure to check for Python syntax errors or undefined names + flake8 . --count --extend-select=E9,F63,F7,F82 --show-source --statistics + - uses: ammaraskar/sphinx-problem-matcher@master + - name: Generate docs + if: always() # run even if the previous step failed + working-directory: ./docs + run: | + echo "::add-matcher::.github/sphinx.json" + make html SPHINXOPTS="-W --keep-going" + - name: Run doctests + if: always() # run even if the previous step failed + working-directory: ./docs + run: | + echo "::add-matcher::.github/sphinx.json" + make doctest SPHINXOPTS="-W --keep-going" + test: + name: Python ${{ matrix.python-version }}, ${{ matrix.os }} + runs-on: ${{ matrix.os }} + defaults: + run: + shell: bash -l {0} + strategy: + fail-fast: true + matrix: + os: ["ubuntu-latest", "macos-latest", "windows-latest"] + python-version: ["3.10", "3.11"] + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Cache conda + uses: actions/cache@v3 + env: + CACHE_NUMBER: 0 # Increase to reset the cache + with: + path: ~/conda_pkgs_dir + key: py${{ matrix.python-version }}-${{ matrix.os }}-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('environment.yml') }} + - name: Install pyleco requirements + uses: conda-incubator/setup-miniconda@v2 + with: + python-version: ${{ matrix.python-version }} + environment-file: environment.yml + activate-environment: pyleco + auto-update-conda: true + use-only-tar-bz2: true # for caching to work properly + - name: Install Pyleco + # If the pytest problem matcher stops working because of bad paths, do an editable install + run: pip install .[dev] + - name: Pyleco version + run: python -c "import pyleco;print(pyleco.__version__)" + - name: Conda info & list + run: | + conda info + conda list + - name: Run pytest with xvfb + if: runner.os == 'Linux' + run: | + echo "::add-matcher::.github/pytest.json" + xvfb-run -a pytest + - name: Run pytest + if: runner.os != 'Linux' + run: | + echo "::add-matcher::.github/pytest.json" + pytest diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..97c821792 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PyMeasure.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PyMeasure.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/PyMeasure" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PyMeasure" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..c23b467a1 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,3 @@ +###### +PyLeco +###### diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 000000000..aefe0b35c --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,242 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +%SPHINXBUILD% 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 +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PyMeasure.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PyMeasure.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/environment.yml b/environment.yml index 5f5bb44e6..551e9401d 100644 --- a/environment.yml +++ b/environment.yml @@ -2,12 +2,16 @@ name: pyleco channels: - conda-forge dependencies: - - pyzmq=25.0.0 + - pyzmq=25.1.0 + - pip # don't pin, to gain newest conda compatibility fixes + - pip: + - jsonrpc2-pyclient==2.2.12 + - openrpc==6.3.17 + - uuid7==0.1.0 # Development dependencies below - pytest=7.2.0 + - pytest-runner=6.0.0 + - flake8=6.0.0 - setuptools_scm # don't pin, to get newest features - - sphinx=6.1.3 - - sphinx_rtd_theme=1.0.0 - # - pip # don't pin, to gain newest conda compatibility fixes - # - pip: - # - xxx + # - sphinx=6.1.3 + # - sphinx_rtd_theme=1.0.0 diff --git a/pyleco/__init__.py b/pyleco/__init__.py index e69de29bb..1c806830c 100644 --- a/pyleco/__init__.py +++ b/pyleco/__init__.py @@ -0,0 +1,51 @@ +# +# This file is part of the PyLECO package. +# +# Copyright (c) 2023-2023 PyLECO Developers +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +# + +import warnings + +# Maximally flexible approach to obtain version numbers, based on this approach: +# https://github.com/pypa/setuptools_scm/issues/143#issuecomment-672878863 +# Sadly, this does not work with editable installs, which bake in version info on installation. +# see also https://github.com/pyusb/pyusb/pull/307#issuecomment-650797688 +try: + # If a user has setuptools_scm installed, assume they want the most up to date version string. + # Alternatively, we could use a dummy dev module that is never packaged whose presence signals + # that we are in an editable install/repo, see https://github.com/pycalphad/pycalphad/pull/341 + import setuptools_scm + __version__ = setuptools_scm.get_version(root='..', relative_to=__file__) + del setuptools_scm +except (ImportError, LookupError): + # Setuptools_scm was not found, or it could not find a version, so use installation metadata. + from importlib.metadata import version, PackageNotFoundError + try: + __version__ = version("pyleco") + # Alternatively, if the current approach is too slow, we could add + # 'write_to = "pyleco/_version.py"' in pyproject.toml and use the generated file here: + # from ._version import version as __version__ + except PackageNotFoundError: + warnings.warn('Could not find pyleco version, it does not seem to be installed. ' + 'Either install it (editable or full) or install setuptools_scm') + __version__ = '0.0.0' + finally: + del version, PackageNotFoundError diff --git a/pyproject.toml b/pyproject.toml index 405e9fc1c..0576cb558 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,10 +16,10 @@ classifiers = [ requires-python = ">=3.10" dependencies = [ - "pyzmq", - "openrpc", - "jsonrpc2-pyclient", - "uuid7", + "pyzmq" >= 22.3.0, + "openrpc" >= 6.3.17, + "jsonrpc2-pyclient" >= 2.2.12, + "uuid7" >= 0.1.0, ] [project.optional-dependencies] @@ -39,3 +39,9 @@ build-backend = "setuptools.build_meta" [tool.setuptools_scm] # write_to = "pyleco/_version.py" + +[tool.black] +line-length = 100 + +[tool.isort] +profile = "black" diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 000000000..5a05141a8 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,6 @@ +[flake8] +exclude = .git,__pycache__,docs/conf.py,build,dist +max-line-length = 100 +max-complexity = 15 +per-file-ignores = + __init__.py:F401