Skip to content

Commit

Permalink
Basic installation docs for apple wallet.
Browse files Browse the repository at this point in the history
  • Loading branch information
rnixx committed Dec 12, 2024
1 parent 7e9d07d commit 34e54f6
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 17 deletions.
3 changes: 2 additions & 1 deletion source/packages/edutap_wallet_apple/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ maxdepth: 2
caption: Contents
---
installation
reference
```
```
41 changes: 41 additions & 0 deletions source/packages/edutap_wallet_apple/installation.md
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
```
36 changes: 20 additions & 16 deletions source/packages/edutap_wallet_google/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
```

0 comments on commit 34e54f6

Please sign in to comment.