personal-tool or plex-tool or pete: A collection of things I use. Available as rust executable, library, or python module. Let's see how much stuff i can cramp in here.
This repository has been archived on 2024-10-16. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Christoph J. Scherr 6c345f6d81 version increment
Signed-off-by: PlexSheep <software@cscherr.de>
2023-07-15 15:36:23 +02:00
.github/workflows maturin init 2023-07-06 22:06:31 +02:00
python/libpt user controlled timeout for net monitor 2023-07-10 21:54:28 +02:00
scripts working logger in python with stub 2023-07-08 01:15:40 +02:00
src net monitor uptime now uses serde 2023-07-12 19:15:42 +02:00
tests rename library to pt (internally) 2023-07-09 21:16:23 +02:00
.gitignore Initial commit 2023-07-06 22:05:34 +02:00
Cargo.toml version increment 2023-07-15 15:36:23 +02:00
LICENSE Initial commit 2023-07-06 22:05:34 +02:00
README.md packaging for pypi 2023-07-09 21:41:39 +02:00
pyproject.toml packaging for pypi 2023-07-09 21:41:39 +02:00

README.md

pt / libpt

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

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

libpt has been packaged for pypi.org.

You can install it with pip install libpt

Installing from crates.io

libpt has been packaged for crates.io.

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.

You can add the registry to your config.toml and then cargo add libpt

Package

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

Mirrored

The origin of this repository is git.cscherr.de

It is mirrored to:

License

GPL-3 or newer.