Browse Source

update package metadata

pull/3/head
Brett Langdon 5 years ago
parent
commit
79ce82602d
Signed by: brettlangdon GPG Key ID: A70042D88B95AA2B
2 changed files with 26 additions and 0 deletions
  1. +23
    -0
      README.md
  2. +3
    -0
      pyproject.toml

+ 23
- 0
README.md View File

@ -7,3 +7,26 @@ from Python 3.8.
**Note:** This module does _not_ backport any of the built-in
[audit events](https://docs.python.org/3.8/library/audit_events.html#audit-events).
## Installation
```
pip install sysaudit
```
## Usage
`sysaudit` can be used as a drop-in replacement for `sys.audit` and `sys.addaudithook`.
``` python
import sysaudit
def hook(event, args):
print("Event:", event, args)
sysaudit.addaudithook(hook)
sysaudit.audit("event_name", 1, 2, dict(key="value"))
# Event: event_name (1, 2, {'key': 'value'})
```

+ 3
- 0
pyproject.toml View File

@ -5,6 +5,9 @@ description = "Backport module for sys.audit and sys.addaudithook from Python 3.
authors = ["brettlangdon <me@brett.is>"]
license = "MIT"
build = "build.py"
repository = "https://github.com/brettlangdon/sysaudit"
homepage = "https://github.com/brettlangdon/sysaudit"
readme = "README.md"
[tool.poetry.dependencies]
python = "~2.7 || ~=3.5"


Loading…
Cancel
Save