Skip to content

Commit

Permalink
Release v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
robin-nitrokey committed Jul 29, 2024
1 parent c5f8415 commit 207f03a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@
## Unreleased

-

## [v0.1.0](https://github.com/Nitrokey/nitrokey-sdk-py/releases/tag/v0.1.0) (2024-07-29)

Initial release with support for Nitrokey 3 and Nitrokey Passkey devices and the admin, provisioner and secrets app.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,30 @@ The SDK supports these devices and features:

## Installation

The Nitrokey Python SDK has not been released yet.
You can install the current version from GitHub using the following command:
The Nitrokey Python SDK is released to the [Python Package Index][pypi] (PyPI) and can be installed with `pip`:

[pypi]: https://pypi.org/project/nitrokey/

```
$ pip install nitrokey
```
$ pip install "nitrokey @ git+https://github.com/Nitrokey/nitrokey-sdk-py.git"

The releases are also available as [signed tags][releases] in the GitHub repository [Nitrokey/nitrokey-sdk-py][github].

[releases]: https://github.com/Nitrokey/nitrokey-sdk-py/releases
[github]: https://github.com/Nitrokey/nitrokey-sdk-py

## Getting Started

```python
from nitrokey.nk3 import NK3
from nitrokey.nkpk import NKPK

print("Connected Nitrokey devices:")
for device in NK3.list():
print(f"- {device.name} at {device.path}")
for device in NKPK.list():
print(f"- {device.name} at {device.path}")
```

## Compatibility
Expand Down

0 comments on commit 207f03a

Please sign in to comment.