-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Basic installation docs for apple wallet.
- Loading branch information
Showing
3 changed files
with
63 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,6 +9,7 @@ maxdepth: 2 | |
caption: Contents | ||
--- | ||
installation | ||
reference | ||
``` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Installation and Configuration | ||
|
||
## Preconditions | ||
|
||
Python 3.10+, currently up to 3.13 is tested. | ||
|
||
## Installation | ||
|
||
The package is hosted at the Python Package Index (PyPI) and can be installed using `pip install edutap.wallet_apple`. | ||
|
||
We recommend working with `uv` | ||
|
||
```bash | ||
uv venv -p 3.13.0 | ||
source .venv/bin/activate | ||
uv pip install edutap.wallet_apple | ||
``` | ||
|
||
## Configuration | ||
|
||
Write me | ||
|
||
## Development | ||
|
||
Run unit tests: | ||
|
||
```bash | ||
uvx --with tox-uv tox -e test -- -m "not integration" | ||
``` | ||
|
||
Run integration tests: | ||
|
||
```bash | ||
uvx --with tox-uv tox -e test -- -m "integration" | ||
``` | ||
|
||
Format code and run checks: | ||
|
||
```bash | ||
uvx --with tox-uv tox -e lint | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters