Skip to content

Commit

Permalink
Updates README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
captain-fox committed May 11, 2020
1 parent 7d9589a commit 955573b
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# airpress

A frustration-free compression tool for PKPass files
Compression tool for PKPass archives.

AirPress does compression in runtime memory without creating temporary files or directories,
which is handy for server-side implementation.

## Installation
From PyPI:

`pip install airpress`

## Quickstart
AirPress is a tool to sign and compress Apple PKPass archives.
Compression and signature occur in runtime memory without creating temporary files or directories.

```python
from airpress import PKPass

Expand All @@ -26,9 +26,11 @@ p.sign(cert=bytes(...), key=bytes(...), password=bytes(...))
# Calling `bytes()` on signed `PKPass` will compress it into zip archive and return its `bytes` representation.
_ = bytes(p)
```

In most cases you're likely to return `pkpass` as `http` response and `bytes` object is exactly what you need.
It's up to you how to handle `.pkpass` archive from this point.
`PKPass` will raise human-readable errors in case something is wrong with pass package you're trying to sign.
`PKPass` will raise human-readable errors in case something is
wrong with pass package you're trying to sign and compress.

## Example

Expand Down

0 comments on commit 955573b

Please sign in to comment.