Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adopt Pupil Labs Python Module Structure #49

Merged
merged 73 commits into from
Feb 24, 2022
Merged

Adopt Pupil Labs Python Module Structure #49

merged 73 commits into from
Feb 24, 2022

Conversation

papr
Copy link
Contributor

@papr papr commented Feb 24, 2022

Differences to official skeleton:

  • Defer as much package metadata to setup.cfg as possible - The packages fields needs to be defined in setup.py for the skbuild generated data to be included correctly
  • Use conda to install dependencies (eigen+opencv) in tox and readthedocs
  • Use importlib.metadata to read version during runtime instead of writing it to version.py

jaraco and others added 30 commits December 8, 2020 16:29
* Replace pep517.build with build

Resolves #30

* Prefer simple usage

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
* Use `extend-ignore` in flake8 config

This option allows to add extra ignored rules to the default list
instead of replacing it.

The default exclusions are: E121, E123, E126, E226, E24, E704,
W503 and W504.

Fixes #28.

Refs:
* https://github.com/pypa/setuptools/pull/2486/files#r541943356
* https://flake8.pycqa.org/en/latest/user/options.html#cmdoption-flake8-extend-ignore
*
https://flake8.pycqa.org/en/latest/user/options.html#cmdoption-flake8-ignore

* Enable complexity limit. Fixes jaraco/skeleton#34.

* Replace pep517.build with build (#37)

* Replace pep517.build with build

Resolves #30

* Prefer simple usage

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>

* Use license_files instead of license_file in meta (#35)

Singular `license_file` is deprecated since wheel v0.32.0.

Refs:
* https://wheel.readthedocs.io/en/stable/news.html
* https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
* Added a config for dependabot.

* Update features list for dependabot.

Co-authored-by: KOLANICH <kolan_n@mail.ru>
This change adds `nitpicky=True` (which is an equivalent of `-n`) to
make Sphinx emit warnings for any references to non-existing targets.
Then, it adds `-W` to make it fail whenever a single warning is seen.
Finally, `--keep-going` allows Sphinx to print out all the warnings
before exiting instead of showing just one and bailing.

Resolves #29

Refs:
* https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-n
* https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-W
* https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-keep-going
papr and others added 28 commits December 9, 2021 15:45
updates:
- [github.com/pre-commit/pre-commit-hooks: v4.0.1 → v4.1.0](pre-commit/pre-commit-hooks@v4.0.1...v4.1.0)
- [github.com/asottile/pyupgrade: v2.29.0 → v2.31.0](asottile/pyupgrade@v2.29.0...v2.31.0)
- [github.com/psf/black: 21.10b0 → 21.12b0](psf/black@21.10b0...21.12b0)
- [github.com/asottile/setup-cfg-fmt: v1.19.0 → v1.20.0](asottile/setup-cfg-fmt@v1.19.0...v1.20.0)
Add workaround for flake8 and sphinx bugs
updates:
- [github.com/pycqa/flake8: 3.9.2 → 4.0.1](PyCQA/flake8@3.9.2...4.0.1)
- [github.com/psf/black: 21.12b0 → 22.1.0](psf/black@21.12b0...22.1.0)
Avoids tholo/pytest-flake8#81 when using flake8 through pytest-flake8
Prevents pytest from importing the file with an error due to missing plsd dependency
Ensures skbuild recognizes the files and adds them to the wheel
@papr papr merged commit 9d4bceb into master Feb 24, 2022
@papr papr deleted the pl-skeleton branch February 24, 2022 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants