diff --git a/source/packages/edutap_wallet_apple/index.md b/source/packages/edutap_wallet_apple/index.md index 4b98664..b840761 100644 --- a/source/packages/edutap_wallet_apple/index.md +++ b/source/packages/edutap_wallet_apple/index.md @@ -9,6 +9,7 @@ maxdepth: 2 caption: Contents --- +installation reference -``` \ No newline at end of file +``` diff --git a/source/packages/edutap_wallet_apple/installation.md b/source/packages/edutap_wallet_apple/installation.md new file mode 100644 index 0000000..6046746 --- /dev/null +++ b/source/packages/edutap_wallet_apple/installation.md @@ -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 +``` diff --git a/source/packages/edutap_wallet_google/installation.md b/source/packages/edutap_wallet_google/installation.md index 7d74f2e..bd1d4cc 100644 --- a/source/packages/edutap_wallet_google/installation.md +++ b/source/packages/edutap_wallet_google/installation.md @@ -16,22 +16,6 @@ source .venv/bin/activate uv pip install edutap.wallet_google ``` -## Development - -## uv pip install -e .[test,typecheck,develop] - -Run all tests with - -```bash -tox -e tests -``` - -Check codestyle with - -```bash -tox -e lint -``` - ## Configuration Configuration is done using environment variables. @@ -70,3 +54,23 @@ export EDUTAP_WALLET_GOOGLE_ISSUER_ID=1234567890123456789 The traffic from and to Google can be logged to a file. If the environment variable `EDUTAP_WALLET_GOOGLE_RECORD_API_CALLS_DIR` is set to a writeable directory, all traffic is recorded there. + +## 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 +```