diff --git a/README.md b/README.md index a20eba1..0b563cc 100644 --- a/README.md +++ b/README.md @@ -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'}) +``` diff --git a/pyproject.toml b/pyproject.toml index 1b02858..b72ec3f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,6 +5,9 @@ description = "Backport module for sys.audit and sys.addaudithook from Python 3. authors = ["brettlangdon "] 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"