link docu files

members/pt-py/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Christoph Johannes Scherr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

members/pt-py/README.md

@@ -0,0 +1,76 @@
+# pt / libpt
+
+![pt-logo](data/media/pt-logo.svg)
+
+`pt` stands for either one of "personal tool", "plex tool", "pete" or something among those lines.
+It is a collection of tools that i might or might not use. The intended purpose of this repo is that
+I program whatever i feel is worth having in a personal thing into it, then use it as either a lib,
+crate, python module or executable.
+
+Let's see if I make it a bloated mess or stop committing after 30 hello worlds.
+
+#### But the name `pt` / `libpt` already exists!
+
+So what? I don't care. Besides, there is not enough names to name everything unique.
+
+## Dependencies
+
+- See `cargo.toml`
+- [openssl bindings for rust](https://docs.rs/openssl/latest/openssl/)
+- [Python](https://www.python.org/)
+- [`maturin`](https://maturin.rs) - `pip install maturin`
+
+## Compiling & Installing from source
+
+If you only want the rust library, you can simply build it with `cargo build`. Add it to your
+project like any other local dependency.
+
+If you want to use the python variant too, you need to compile with maturing.
+
+- Install in `venv`: `maturin develop --release`
+- Install in system: `maturin build --release && pip install target/wheels/libpt-x.x.x-*`
+
+## Installing from [pypi](https://pypi.org)
+
+`libpt` has been packaged for [pypi.org](https://pypi.org/project/libpt/).
+
+You can install it with `pip install libpt`
+
+## Installing from [crates.io](https://crates.io)
+
+`libpt` has been packaged for [crates.io](https://crates.io/crates/libpt).
+
+You can add the library to your project with `cargo add libpt`.
+
+## Installing from my personal package registry
+
+`libpt` has been packaged for [git.cscherr.de](https://git.cscherr.de).
+
+You can add the registry to your `config.toml` and then `cargo add libpt`
+
+[Package](https://git.cscherr.de/PlexSheep/-/packages/cargo/libpt/)
+
+## Testing
+
+Testing needs to be done separately for the rust and python parts:
+
+- Rust testing with `cargo test`
+- Python testing with `./scripts/pytests.sh` or `python -m unittest discover -fs tests/python`
+
+## Documentation
+
+The documentation can be automatically generated with `cargo doc --open`.
+
+An up to date version of the Documentation can be found [here](https://docs.rs/libpt/)
+
+## Mirrored
+
+The origin of this repository is [git.cscherr.de](https://git.cscherr.de/PlexSheep/pt)
+
+It is mirrored to:
+- [Codeberg](https://codeberg.org/PlexSheep/pt)
+
+
+## License
+
+**Pt is MIT Licensed**