Skip to content

Adopt Pupil Labs Python Skeleton #28

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

Open
wants to merge 80 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
80 commits
Select commit Hold shift + click to select a range
c681f67
Collapse skeleton history from archive/2020-12
jaraco Dec 8, 2020
2667241
Update skeleton description to describe the periodic collapse. Fixes …
jaraco Dec 13, 2020
150321c
Enable automerge
jaraco Dec 13, 2020
4b13346
Automatically inject project name in docs heading.
jaraco Dec 29, 2020
cfe99a5
pre-commit autoupdate
jaraco Dec 30, 2020
060d491
Rename 'Automated Tests' to simply 'tests'
jaraco Dec 30, 2020
2b839ba
Add note about automatic merging of PRs and the requirements and limi…
jaraco Dec 30, 2020
a36768a
Prefer pytest-enabler to jaraco.test
jaraco Dec 31, 2020
3e876d7
Enable complexity limit. Fixes jaraco/skeleton#34.
jaraco Jan 9, 2021
1731fbe
Replace pep517.build with build (#37)
webknjaz Jan 9, 2021
a9b3f68
Use license_files instead of license_file in meta (#35)
webknjaz Jan 9, 2021
77fbe1d
Use `extend-ignore` in flake8 config (#33)
webknjaz Jan 9, 2021
0df4081
Add support for namespace packages. Closes jaraco/skeleton#40.
jaraco Jan 16, 2021
51298a2
Normalize indentation
jaraco Feb 10, 2021
743af72
Exclude dist from discovered packages. Fixes jaraco/skeleton#46.
jaraco Feb 21, 2021
38fff62
Added an .editorconfig. Pull request jaraco/skeleton#43.
KOLANICH Feb 6, 2021
5e41679
It's no longer necessary to filter this warning and it's not a warnin…
jaraco Feb 22, 2021
d9a13c7
Bump minimum pytest
jaraco Feb 22, 2021
bf9fae2
Require twine 3 with keyring unconditionally required.
jaraco Mar 6, 2021
7bdab57
Add comments indicating why the exclusions are present
jaraco Mar 7, 2021
14312a5
Exclude mypy on Python 3.10 as workaround for python/typed_ast#156.
jaraco Mar 7, 2021
af54451
Bump minimums on pytest-checkdocs and pytest-enabler as found on Setu…
jaraco Mar 7, 2021
86efb88
Also deny black on Python 3.10 as workaround for python/typed_ast#156.
jaraco Mar 7, 2021
7fe4ab8
Add leading */ to coverage.run.omit. Workaround for pytest-dev/pytest…
jaraco Mar 15, 2021
6e2d0ba
Remove automerge. Fixes jaraco/skeleton#49.
jaraco Apr 26, 2021
2f690f6
Enable dependabot (#50)
jaraco Apr 26, 2021
6c1c45b
Replace md file with badge linking to documentation site. Fixes jarac…
jaraco Apr 26, 2021
8698127
Make sphinx fail on any warnings (#36)
webknjaz Apr 26, 2021
4a734d4
Test on Python 3.10
jaraco May 20, 2021
1b16520
Remove setup_requires, obviated by build-requires in pyproject.toml.
jaraco May 26, 2021
85d08db
Suppress deprecation warnings in flake8 and packaging.tags. Ref pypa/…
jaraco Jun 3, 2021
5a8384e
Use shutil for rmtree
bhrutledge Jun 12, 2021
14787e6
Rely on setuptools 56 and drop the explicit mention of the license fi…
jaraco Jul 16, 2021
212e995
Remove workaround for python/typed_ast#156.
jaraco Jul 16, 2021
498b965
Use line continuations to indicate which exclusions are for which wor…
jaraco Jul 16, 2021
719a7ce
Remove blacken docs as it cannot honor Python's default repr. Ref aso…
jaraco Jul 21, 2021
a76a548
.editorconfig: Set max_line_length to 88 for Python files.
darkvertex Jul 26, 2021
8ea55f2
Add intersphinx mappings for Python to prevent spurious nitpicky fail…
jaraco Sep 18, 2021
dc43378
Test on Python 3.10 (final).
jaraco Oct 6, 2021
5823e9c
Rely on pytest 6 and drop workaround for pytest-dev/pytest#6178.
jaraco Oct 7, 2021
aae281a
Remove wheel from build requirements. It's implied for wheel builds. …
jaraco Oct 22, 2021
0019b0a
Require Python 3.7 or later.
jaraco Nov 25, 2021
d9008b5
Remove filtered warnings, addressed upstream.
jaraco Nov 25, 2021
b805634
Add name_space folder to src/ and include top-level module files
papr Dec 9, 2021
b58c2fc
Add pre-commit hooks
papr Dec 9, 2021
2e49439
Apply pre-commit hooks
papr Dec 9, 2021
0f4cdc6
Add gitignore
papr Dec 9, 2021
d7fe850
Generate version.py on install
papr Dec 9, 2021
84d112e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 9, 2021
d5803d2
Merge pull request #1 from pupil-labs/generate-version-on-install
papr Dec 9, 2021
3782a11
pre-commit: Use black profile for isort
papr Dec 17, 2021
08e81f4
[pre-commit.ci] pre-commit autoupdate
pre-commit-ci[bot] Jan 3, 2022
7e262a4
Add Python 3.8 tests to GA
papr Jan 7, 2022
811532a
Merge remote-tracking branch 'origin/pre-commit-ci-update-config' int…
papr Jan 7, 2022
ec37115
Add flake8<4 constraint to avoid https://github.com/tholo/pytest-flak…
papr Jan 20, 2022
86d90f6
Add sphinx<4.4 constraint to correctly document TypeVars
papr Jan 20, 2022
903e4d9
Run flake8 as part of the pre-commit hooks. Use same version as in "t…
papr Jan 20, 2022
d1fcc97
Take over Pupil Cloud flake8 config
papr Jan 20, 2022
33527ac
Fix flake8 warning about unused import
papr Jan 20, 2022
e22806f
Merge pull request #3 from pupil-labs/improvements
papr Jan 20, 2022
42e2a54
[pre-commit.ci] pre-commit autoupdate
pre-commit-ci[bot] Jan 31, 2022
c132137
Merge pull request #4 from pupil-labs/pre-commit-ci-update-config
papr Feb 17, 2022
fa620c0
Run flake8 only via pre-commit
papr Feb 17, 2022
a1199d8
Read package version using importlib
papr Feb 25, 2022
f80824b
Do not check black format via pytest
papr Feb 25, 2022
d60e54a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 25, 2022
6ee9eaf
Merge pull request #5 from pupil-labs/importlib
papr Feb 25, 2022
fc99c80
[pre-commit.ci] pre-commit autoupdate
pre-commit-ci[bot] Mar 14, 2022
378517b
Merge pull request #6 from pupil-labs/pre-commit-ci-update-config
papr Apr 21, 2022
cfd0e8c
Merge remote-tracking branch 'skeleton/main' into pl_project_structure
papr Apr 22, 2022
698b637
Remove bump2version config
papr Apr 22, 2022
5ba1361
Remove license header from source files
papr Apr 22, 2022
f3440eb
Revert project name change
papr Apr 22, 2022
29edf24
Use explicit type annotations for ClassVars
papr Apr 22, 2022
0676ffe
Cleanup documentation
papr Apr 22, 2022
8fe4d8e
Remove outdated GA + test on py3.6
papr Apr 22, 2022
0388add
Fix missing dependency + unknown version
papr May 2, 2022
af5b7af
Only perform custom transform in case of 4 points
papr May 2, 2022
4b8ce62
Assume an undistorted image as crop input
papr May 2, 2022
fefb00d
Add note about example dependencies
papr May 2, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .bumpversion.cfg

This file was deleted.

7 changes: 7 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[run]
omit =
# leading `*/` for pytest-dev/pytest-cov#456
*/.tox/*

[report]
show_missing = True
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
root = true

[*]
charset = utf-8
indent_style = tab
indent_size = 4
insert_final_newline = true
end_of_line = lf

[*.py]
indent_style = space
max_line_length = 88

[*.{yml,yaml}]
indent_style = space
indent_size = 2
16 changes: 16 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[flake8]
max-line-length = 88

max-complexity = 18

extend-ignore =
# Black creates whitespace before colon
E203
W503
F541

extend-select = B,C,E,F,W,T4,B9
exclude =
.venv
.pyenv
__pycache__
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: 2
updates:
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "daily"
allow:
- dependency-type: "all"
69 changes: 0 additions & 69 deletions .github/workflows/build-test-deploy.yml

This file was deleted.

50 changes: 50 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: tests

on: [push, pull_request]

jobs:
test:
strategy:
matrix:
python:
- 3.6
- 3.7
- 3.8
- 3.9
- "3.10"
platform:
- ubuntu-latest
- macos-latest
- windows-latest
runs-on: ${{ matrix.platform }}
steps:
- uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python }}
- name: Install tox
run: |
python -m pip install tox
- name: Run tests
run: tox

release:
needs: test
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: "3.10"
- name: Install tox
run: |
python -m pip install tox
- name: Release
run: tox -e release
env:
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
184 changes: 183 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,159 @@
version.py

# Created by https://www.toptal.com/developers/gitignore/api/python,visualstudiocode,macos,windows,linux,pycharm
# Edit at https://www.toptal.com/developers/gitignore?templates=python,visualstudiocode,macos,windows,linux,pycharm

### Linux ###
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### PyCharm ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf

# AWS User-specific
.idea/**/aws.xml

# Generated files
.idea/**/contentModel.xml

# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml

# Gradle
.idea/**/gradle.xml
.idea/**/libraries

# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated, and may cause churn. Uncomment if using
# auto-import.
# .idea/artifacts
# .idea/compiler.xml
# .idea/jarRepositories.xml
# .idea/modules.xml
# .idea/*.iml
# .idea/modules
# *.iml
# *.ipr

# CMake
cmake-build-*/

# Mongo Explorer plugin
.idea/**/mongoSettings.xml

# File-based project format
*.iws

# IntelliJ
out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Cursive Clojure plugin
.idea/replstate.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Editor-based Rest Client
.idea/httpRequests

# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser

### PyCharm Patch ###
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721

# *.iml
# modules.xml
# .idea/misc.xml
# *.ipr

# Sonarlint plugin
# https://plugins.jetbrains.com/plugin/7973-sonarlint
.idea/**/sonarlint/

# SonarQube Plugin
# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
.idea/**/sonarIssues.xml

# Markdown Navigator plugin
# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
.idea/**/markdown-navigator.xml
.idea/**/markdown-navigator-enh.xml
.idea/**/markdown-navigator/

# Cache file creation bug
# See https://youtrack.jetbrains.com/issue/JBR-2257
.idea/$CACHE_FILE$

# CodeStream plugin
# https://plugins.jetbrains.com/plugin/12206-codestream
.idea/codestream.xml

### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down Expand Up @@ -50,6 +206,7 @@ coverage.xml
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
Expand All @@ -72,6 +229,7 @@ instance/
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
Expand Down Expand Up @@ -175,6 +333,30 @@ Icon
Network Trash Folder
Temporary Items
.apdisk
# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace

# Local History for Visual Studio Code
.history/

### VisualStudioCode Patch ###
# Ignore all local history of files
.history
.ionide

# Support for Project snippet scope
!.vscode/*.code-snippets

### Windows ###
# Windows thumbnail cache files
Expand Down Expand Up @@ -202,4 +384,4 @@ $RECYCLE.BIN/
# Windows shortcuts
*.lnk

# End of https://www.toptal.com/developers/gitignore/api/macos,windows,linux
# End of https://www.toptal.com/developers/gitignore/api/python,visualstudiocode,macos,windows,linux,pycharm
Loading