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 2652a57d36
Release-plz / Release-plz release (push) Failing after 12s Details
cargo devel CI / cargo CI (push) Has been cancelled Details
chore: add release-plz ci
2024-10-16 17:33:32 +02:00
.gitea/workflows chore: add release-plz ci 2024-10-16 17:33:32 +02:00
.github/workflows chore: change ci message to fit conventional git commits 2024-10-16 13:49:50 +02:00
data more configs 2024-01-16 18:13:39 +01:00
members chore: bump version 2024-09-08 01:34:28 +02:00
scripts chore: reset publish script 2024-09-08 01:27:27 +02:00
src chore: add more clippy lints and fix some 2024-07-09 17:36:16 +02:00
.gitignore Initial commit 2023-07-06 22:05:34 +02:00
.python-version add python interface crate #57 2024-02-28 16:42:27 +01:00
Cargo.toml chore: bump version 2024-09-08 01:34:28 +02:00
LICENSE chore: change LICENSE to GPL-3.0-or-later 2024-06-28 08:56:21 +02:00
README.md docs: python not implemented notice #98 2024-08-30 18:06:46 +02:00

README.md

pt / libpt

Project badge Crates.io License Gitea Release Gitea language count cargo checks and tests

pt-logo

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.

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

The Python interface of libpt is currently not implemented, but it is planned to eventually re add it. Meanwhile, you can use a much older version if you really want.

⚠️ This will install a very old version

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

License

Pt is MIT Licensed