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

Add initial project structure #1

Merged
merged 1 commit into from
Jul 22, 2024
Merged

Add initial project structure #1

merged 1 commit into from
Jul 22, 2024

Conversation

robin-nitrokey
Copy link
Member

This patch adds the initial project structure, including licenses, linters and their configuration, and a basic test case that ensures that the module can be loaded.

Most tooling is taken over from pynitrokey. One notable exception is that flit is replaced by poetry. This only affects developers, not end users. We recently made the same change in nitrokey-app2 (Nitrokey/nitrokey-app2#172), so I think it makes sense to use the same tooling here.

In the CI builds, we check that both the lockfile and the latest dependency versions work. It would good to also run it for the minimum versions specified in pyproject.toml, but this is currently not supported by poetry or pip:

README.md Outdated Show resolved Hide resolved
This patch adds the initial project structure, including licenses,
linters and their configuration, and a basic test case that ensures that
the module can be loaded.

Most tooling is taken over from pynitrokey.  One notable exception is
that flit is replaced by poetry.  This only affects developers, not end
users.  We recently made the same change in nitrokey-app2 [0], so I
think it makes sense to use the same tooling here.

[0] Nitrokey/nitrokey-app2#172

In the CI builds, we check that both the lockfile and the latest
dependency versions work.  It would good to also run it for the minimum
versions specified in pyproject.toml, but this is currently not
supported by poetry or pip:

python-poetry/poetry#3527
pypa/pip#8085
@robin-nitrokey robin-nitrokey merged commit faa26cb into main Jul 22, 2024
14 checks passed
@robin-nitrokey robin-nitrokey deleted the init branch July 22, 2024 16:11
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.

3 participants