kanidm/pykanidm/README.md

# kanidm

A Python module for interacting with Kanidm.

Currently in very very very early beta, please [log an issue](https://github.com/kanidm/kanidm/issues/new/choose) for feature requests and bugs.

## Installation

```shell
python -m pip install kanidm
```

## Documentation

Documentation can be generated by [cloning the repository](https://github.com/kanidm/kanidm) and running `make docs/pykanidm/build`. The documentation will appear in `./pykanidm/site`. You'll need make and the [poetry](https://pypi.org/project/poetry/) package installed.


## Changelog

| Version | Date | Notes |
| ---     | ---  | ---   |
| 0.0.1   | 2022-08-16 | Initial release |
| 0.0.2   | 2022-08-16 | Updated license, including test code in package |
| 0.0.3   | 2022-08-17 | Updated test suite to allow skipping of network tests |
Python module and rewritten RADIUS integration (#826) * added python kanidm module * rewrote RADIUS integration * updated the documentation * updating github actions to run more often * BLEEP BLOOP ASYNCIO IS GR8 * adding config to makefile to run pykanidm tests Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Firstyear <william@blackhats.net.au> 2022-06-20 12:16:55 +02:00			`# kanidm`

			`A Python module for interacting with Kanidm.`

Published 0.0.3 of kanidm python module (#995) * kanidm python 0.0.3 2022-08-17 13:35:06 +02:00			`Currently in very very very early beta, please [log an issue](https://github.com/kanidm/kanidm/issues/new/choose) for feature requests and bugs.`
Python module and rewritten RADIUS integration (#826) * added python kanidm module * rewrote RADIUS integration * updated the documentation * updating github actions to run more often * BLEEP BLOOP ASYNCIO IS GR8 * adding config to makefile to run pykanidm tests Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Firstyear <william@blackhats.net.au> 2022-06-20 12:16:55 +02:00
Published 0.0.3 of kanidm python module (#995) * kanidm python 0.0.3 2022-08-17 13:35:06 +02:00			`## Installation`
Python module and rewritten RADIUS integration (#826) * added python kanidm module * rewrote RADIUS integration * updated the documentation * updating github actions to run more often * BLEEP BLOOP ASYNCIO IS GR8 * adding config to makefile to run pykanidm tests Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Firstyear <william@blackhats.net.au> 2022-06-20 12:16:55 +02:00
			```shell
			`python -m pip install kanidm`
Published 0.0.3 of kanidm python module (#995) * kanidm python 0.0.3 2022-08-17 13:35:06 +02:00			```

			`## Documentation`

			Documentation can be generated by [cloning the repository](https://github.com/kanidm/kanidm) and running `make docs/pykanidm/build`. The documentation will appear in `./pykanidm/site`. You'll need make and the [poetry](https://pypi.org/project/poetry/) package installed.


			`## Changelog`

			`\| Version \| Date \| Notes \|`
			`\| --- \| --- \| --- \|`
			`\| 0.0.1 \| 2022-08-16 \| Initial release \|`
			`\| 0.0.2 \| 2022-08-16 \| Updated license, including test code in package \|`
			`\| 0.0.3 \| 2022-08-17 \| Updated test suite to allow skipping of network tests \|`