chore: just use github for ci and also add cd

Reviewed-on: #94

.gitea/workflows/cargo-publish.yaml

@@ -1,34 +0,0 @@
-# name: Cargo Check, Format, Fix, Test and publish
-# on:
-#   push:
-#     branches:
-#       - master
-#
-# jobs:
-#   format:
-#     name: cargo CI
-#     permissions:
-#       # Give the default GITHUB_TOKEN write permission to commit and push the
-#       # added or changed files to the repository.
-#       contents: write
-#       package: write
-#     steps:
-#       - name: get repo
-#         uses: actions/checkout@v4
-#       - name: install rust
-#         uses: dtolnay/rust-toolchain@stable
-#         run: cargo install cargo-workspaces
-#       - name: config custom registry
-#         run: |
-#           mkdir -p ~/.cargo/
-#           echo "" > ~/.cargo/config.toml
-#           echo "[registry]" >> ~/.cargo/config.toml
-#           # echo 'token = "Bearer ${{ secrets.CARGO_PUBLISH_CRATESIO }}"' >> ~/.cargo/config.toml
-#           echo 'cscherr = "cscherr"' >> ~/.cargo/config.toml
-#           echo '[registries.cscherr]' >> ~/.cargo/config.toml
-#           echo 'index = "https://git.cscherr.de/PlexSheep/_cargo-index.git"' >> ~/.cargo/config.toml
-#           echo 'token = "Bearer ${{ GITEA_TOKEN }}"' >> ~/.cargo/config.toml
-#           cat ~/.cargo/config.toml
-#       - name: publish crates on git.cscherr.de
-#         run: |
-#           cargo workspaces publish --registry cscherr patch

.gitea/workflows/cargo.yaml.disabled

@@ -16,9 +16,11 @@ jobs:
       - name: get repo
         uses: actions/checkout@v4
       - name: install rust
-        uses: dtolnay/rust-toolchain@stable
+        uses: https://github.com/dtolnay/rust-toolchain@stable
       - name: install additional rust things
-        run: rustup component add rustfmt
+        run: |
+          rustup component add rustfmt
+          rustup component add clippy
       - name: config custom registry
         run: |
           mkdir -p ~/.cargo/
@@ -28,17 +30,17 @@ jobs:
           echo '[registries.cscherr]' >> ~/.cargo/config.toml
           echo 'index = "https://git.cscherr.de/PlexSheep/_cargo-index.git"' >> ~/.cargo/config.toml
           cat ~/.cargo/config.toml
-      - name: cargo check
-        run: cargo check --all-features --all-targets
-      - name: cargo fix
-        run: cargo fix --all-features --all-targets
+      - name: cargo clippy check
+        run: cargo clippy --all-features --all-targets --workspace
+      - name: cargo clippy fix
+        run: cargo clippy --fix --all-features --all-targets --workspace
       - name: cargo fmt
         run: cargo fmt --all
       - name: cargo test
-        run: cargo test --all-features --all-targets
+        run: cargo test --all-features --all-targets --workspace && cargo test --all-features --workspace --doc
       - name: commit back to repository
-        uses: stefanzweifel/git-auto-commit-action@v5
+        uses: https://github.com/stefanzweifel/git-auto-commit-action@v5
         with:
           # Optional. Commit message for the created commit.
           # Defaults to "Apply automatic changes"
-          commit_message: automatic cargo CI changes
+          commit_message: "ci: automatic cargo CI changes"

.github/dependabot.yaml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    # Check for updates every Monday
+    schedule:
+      interval: "weekly"

.github/workflows/cargo.yaml

@@ -0,0 +1,57 @@
+name: Rust CI
+on:
+  pull_request:
+    branches:
+      - '**'
+  push:
+    branches:
+      - '**'
+      # - '!master'
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  CI:
+    runs-on: ubuntu-latest
+    name: cargo CI
+    permissions:
+      # Give the default GITHUB_TOKEN write permission to commit and push the
+      # added or changed files to the repository.
+      contents: write
+    steps:
+      - name: get repo
+        uses: actions/checkout@v4
+      - name: install rust
+        uses: dtolnay/rust-toolchain@stable
+      - name: install additional rust things
+        run: |
+          rustup component add rustfmt
+          rustup component add clippy
+      - name: install python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: config custom registry
+        run: |
+          mkdir -p ~/.cargo/
+          echo "" > ~/.cargo/config.toml
+          echo "[registry]" >> ~/.cargo/config.toml
+          echo 'cscherr = "cscherr"' >> ~/.cargo/config.toml
+          echo '[registries.cscherr]' >> ~/.cargo/config.toml
+          echo 'index = "https://git.cscherr.de/PlexSheep/_cargo-index.git"' >> ~/.cargo/config.toml
+          cat ~/.cargo/config.toml
+      - name: cargo clippy check
+        run: cargo clippy --all-features --all-targets --workspace
+      - name: cargo clippy fix
+        run: cargo clippy --fix --all-features --all-targets --workspace
+      - name: cargo fmt
+        run: cargo fmt --all
+      - name: cargo test
+        run: cargo test --all-features --all-targets --workspace
+      - name: commit back to repository
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          # Optional. Commit message for the created commit.
+          # Defaults to "Apply automatic changes"
+          commit_message: "ci: automatic Rust CI changes"

.github/workflows/release.yaml

@@ -0,0 +1,54 @@
+name: Release-plz
+
+permissions:
+  pull-requests: write
+  contents: write
+
+on:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+
+  # Release unpublished packages.
+  release-plz-release:
+    name: Release-plz release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Run release-plz
+        uses: MarcoIeni/release-plz-action@v0.5
+        with:
+          command: release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+
+  # Create a PR with the new versions and changelog, preparing the next release.
+  release-plz-pr:
+    name: Release-plz PR
+    runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Run release-plz
+        uses: MarcoIeni/release-plz-action@v0.5
+        with:
+          command: release-pr
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

.python-version

@@ -0,0 +1 @@
+rust

Cargo.toml

@@ -1,38 +1,28 @@
 [workspace]
 resolver = "2"
-members = [
-  ".",
-  "members/libpt-core",
-  "members/libpt-math",
-  "members/libpt-log",
-  "members/libpt-net",
-]
+members = [".", "members/libpt-core", "members/libpt-log", "members/libpt-cli"]
 default-members = [".", "members/libpt-core"]
+
 [workspace.package]
 publish = true
-version = "0.3.6"
+version = "0.7.3-alpha.2"
 edition = "2021"
 authors = ["Christoph J. Scherr <software@cscherr.de>"]
-license = "MIT"
+license = "GPL-3.0-or-later"
 description = "Personal multitool"
 readme = "README.md"
-homepage = "https://git.cscherr.de/PlexSheep/libpt"
-repository = "https://git.cscherr.de/PlexSheep/libpt"
-keywords = ["cli", "library"]
-categories = [
-  "command-line-utilities",
-  "development-tools",
-  "development-tools::ffi",
-]
+homepage = "https://git.cscherr.de/PlexSheep/pt"
+repository = "https://git.cscherr.de/PlexSheep/pt"
+keywords = ["library"]
+categories = ["command-line-utilities", "development-tools"]
 
 [workspace.dependencies]
 anyhow = "1.0.79"
 thiserror = "1.0.56"
-libpt-core = { version = "0.3.3", path = "members/libpt-core", registry = "cscherr" }
-libpt-bintols = { version = "0.3.3", path = "members/libpt-bintols", registry = "cscherr" }
-libpt-log = { version = "0.3.3", path = "members/libpt-log", registry = "cscherr" }
-libpt-math = { version = "0.3.3", path = "members/libpt-math", registry = "cscherr" }
-libpt-net = { version = "0.3.3", path = "members/libpt-net", registry = "cscherr" }
+libpt-core = { version = "0.5.0", path = "members/libpt-core" }
+libpt-bintols = { version = "0.5.1", path = "members/libpt-bintols" }
+libpt-log = { version = "0.6.2-alpha.1", path = "members/libpt-log" }
+libpt-cli = { version = "0.2.2-alpha.1", path = "members/libpt-cli" }
 
 [package]
 name = "libpt"
@@ -49,13 +39,13 @@ keywords.workspace = true
 categories.workspace = true
 
 [features]
-default = ["log", "core", "bin"]
+default = ["log", "core"]
 core = []
-math = []
-log = []
-bintols = []
-net = []
-bin = ["dep:clap", "dep:clap-num", "dep:clap-verbosity-flag", "math", "bintols"]
+full = ["default", "core", "log", "bintols", "libpt-cli/full"]
+log = ["dep:libpt-log"]
+log-crate = ["libpt-cli/log"]
+bintols = ["dep:libpt-bintols", "log"]
+cli = ["dep:libpt-cli", "core", "log"]
 
 [lib]
 name = "libpt"
@@ -65,23 +55,12 @@ crate-type = [
   "rlib",
 ]
 
-[[bin]]
-name = "ccc"
-path = "src/ccc/mod.rs"
-required-features = ["bin", "math"]
-
-[[bin]]
-name = "hedu"
-path = "src/hedu/mod.rs"
-required-features = ["bin", "bintols"]
-
-
 [dependencies]
 libpt-core = { workspace = true }
-libpt-bintols = { workspace = true }
-libpt-log = { workspace = true }
-libpt-math = { workspace = true }
-libpt-net = { workspace = true }
-clap = { version = "4.4.4", features = ["derive"], optional = true }
-clap-num = { version = "1.0.2", optional = true }
-clap-verbosity-flag = { version = "2.0.1", optional = true }
+libpt-bintols = { workspace = true, optional = true }
+libpt-log = { workspace = true, optional = true }
+libpt-cli = { workspace = true, optional = true, features = ["log"] }
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

LICENSE

@@ -1,21 +1,675 @@
-MIT License
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
-Copyright (c) 2023 Christoph Johannes Scherr
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-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:
+                            Preamble
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
 
-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.

README.md

@@ -1,5 +1,11 @@
 # pt / libpt
 
+![Project badge](https://img.shields.io/badge/language-Rust-blue.svg)
+![Crates.io License](https://img.shields.io/crates/l/libpt)
+![Gitea Release](https://img.shields.io/gitea/v/release/PlexSheep/pt?gitea_url=https%3A%2F%2Fgit.cscherr.de)
+![Gitea language count](https://img.shields.io/gitea/languages/count/PlexSheep/pt?gitea_url=https%3A%2F%2Fgit.cscherr.de)
+[![cargo checks and tests](https://github.com/PlexSheep/pt/actions/workflows/cargo.yaml/badge.svg)](https://github.com/PlexSheep/pt/actions/workflows/cargo.yaml)
+
 ![pt-logo](data/media/pt-logo.svg)
 
 `pt` stands for either one of "personal tool", "plex tool", "pete" or something among those lines.
@@ -9,6 +15,12 @@ crate, python module or executable.
 
 Let's see if I make it a bloated mess or stop committing after 30 hello worlds.
 
+* [Original Repository](https://git.cscherr.de/PlexSheep/pt)
+* [GitHub Mirror](https://github.com/PlexSheep/pt)
+* [Codeberg Mirror](https://codeberg.org/PlexSheep/pt)
+* [crates.io](https://crates.io/crates/libpt)
+* [docs.rs](https://docs.rs/crate/libpt/)
+
 ## Dependencies
 
 - See `cargo.toml`
@@ -28,12 +40,19 @@ If you want to use the python variant too, you need to compile with maturing.
 
 ## Installing from [pypi](https://pypi.org)
 
-`libpt` has been packaged for [pypi.org](https://pypi.org/project/libpt/).
+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.
 
-You can install it with `pip install libpt`
+> :warning: **This will install a very old version**
+>
+> `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`.
@@ -59,14 +78,6 @@ 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**

members/libpt-bintols/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "libpt-bintols"
 publish.workspace = true
-version.workspace = true
+version = "0.5.1"
 edition.workspace = true
 authors.workspace = true
 license.workspace = true
@@ -20,3 +20,7 @@ libpt-core = { workspace = true }
 libpt-log = { workspace = true }
 anyhow = { workspace = true }
 thiserror = { workspace = true }
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

members/libpt-bintols/src/display.rs

@@ -8,14 +8,15 @@ pub use num_traits::{PrimInt, ToPrimitive};
 /// ### Arguments
 /// * `data` - The data you are trying to dump
 pub fn bytes_to_bin(data: &[u8]) -> String {
-    let mut s = format!("0b{:08b}", data.first().unwrap());
-    for i in 1..data.len() {
-        s.push_str(&format!("_{:08b}", data[i]));
-        if i % 8 == 0 {
-            s.push_str("\n")
+    let mut s = String::new();
+    for (i, dat) in data.iter().enumerate() {
+        if i == 0 {
+            s.push_str(&format!("0b{:08b}", dat));
+        } else {
+            s.push_str(&format!("_{:08b}", dat));
         }
     }
-    return s;
+    s
 }
 
 /// Quickly format a number of Bytes [`usize`] with the corresponding
@@ -34,17 +35,17 @@ where
     T: std::fmt::Debug,
 {
     if total < T::from(KIBI).unwrap() {
-        return format!("{total} B");
+        format!("{total} B")
     } else if T::from(KIBI).unwrap() <= total && total < T::from(MEBI).unwrap() {
-        return format!("{:.2} K", total.to_f64().unwrap() / KIBI as f64);
+        format!("{:.2} K", total.to_f64().unwrap() / KIBI as f64)
     } else if T::from(MEBI).unwrap() <= total && total < T::from(GIBI).unwrap() {
-        return format!("{:.2} M", total.to_f64().unwrap() / MEBI as f64);
+        format!("{:.2} M", total.to_f64().unwrap() / MEBI as f64)
     } else if T::from(GIBI).unwrap() <= total && total < T::from(TEBI).unwrap() {
-        return format!("{:.2} G", total.to_f64().unwrap() / GIBI as f64);
+        format!("{:.2} G", total.to_f64().unwrap() / GIBI as f64)
     } else if T::from(TEBI).unwrap() <= total && total < T::from(PEBI).unwrap() {
-        return format!("{:.2} T", total.to_f64().unwrap() / TEBI as f64);
+        format!("{:.2} T", total.to_f64().unwrap() / TEBI as f64)
     } else if T::from(PEBI).unwrap() <= total && total < T::from(EXBI).unwrap() {
-        return format!("{:.2} P", total.to_f64().unwrap() / PEBI as f64);
+        format!("{:.2} P", total.to_f64().unwrap() / PEBI as f64)
     }
     // now we are starting to reach the sizes that are pretty unrealistic
     // (as of 2023 that is, hello future)
@@ -53,9 +54,9 @@ where
     // to work with a fixed, larger sized datatype
     else {
         let total: u128 = total.to_u128().unwrap();
-        if EXBI <= total && total < ZEBI {
+        if (EXBI..ZEBI).contains(&total) {
             return format!("{:.2} E", total.to_f64().unwrap() / EXBI as f64);
-        } else if ZEBI <= total && total < YOBI {
+        } else if (ZEBI..YOBI).contains(&total) {
             return format!("{:.2} Z", total.to_f64().unwrap() / ZEBI as f64);
         } else if YOBI <= total {
             return format!("{:.2} Y", total.to_f64().unwrap() / YOBI as f64);

members/libpt-bintols/src/hedu/mod.rs

@@ -1,179 +0,0 @@
-//! # Dump data
-//!
-//! This crate is part of [`pt`](../libpt/index.html), but can also be used as a standalone
-//! module.
-//!
-//! This crate is currently empty.
-
-use crate::display::humanbytes;
-use anyhow::{bail, Result};
-use libpt_log::{debug, trace, warn, error};
-use std::io::{prelude::*, Read, SeekFrom};
-
-const BYTES_PER_LINE: usize = 16;
-const LINE_SEP_HORIZ: char = '─';
-const LINE_SEP_VERT: char = '│';
-
-pub struct HeduConfig {
-    pub chars: bool,
-    pub skip: usize,
-    pub show_identical: bool,
-    pub limit: usize,
-    stop: bool,
-    len: usize,
-}
-
-impl HeduConfig {
-    pub fn new(chars: bool, skip: usize, show_identical: bool, limit: usize) -> Self {
-        HeduConfig {
-            chars,
-            skip,
-            show_identical,
-            limit,
-            stop: false,
-            len: usize::MIN,
-        }
-    }
-}
-
-pub trait DataSource: Read {
-    fn skip(&mut self, length: usize) -> std::io::Result<()>;
-}
-impl DataSource for std::io::Stdin {
-    fn skip(&mut self, _length: usize) -> std::io::Result<()> {
-        warn!("can't skip bytes for the stdin!");
-        Ok(())
-    }
-}
-impl DataSource for std::fs::File {
-    fn skip(&mut self, length: usize) -> std::io::Result<()> {
-        self.seek(SeekFrom::Current(length as i64))?;
-        // returns the new position from the start, we don't need it here.
-        Ok(())
-    }
-}
-
-pub fn dump(data: &mut dyn DataSource, mut config: HeduConfig) -> Result<()> {
-    // prepare some variables
-    let mut buf: [[u8; BYTES_PER_LINE]; 2] = [[0; BYTES_PER_LINE]; 2];
-    let mut alt_buf = 0usize;
-    let mut byte_counter: usize = 0;
-
-    // skip a given number of bytes
-    if config.skip > 0 {
-        data.skip(config.skip)?;
-        byte_counter += config.skip;
-        debug!("Skipped {}", humanbytes(config.skip));
-    }
-
-    // print the head
-    print!("DATA IDX {LINE_SEP_VERT} DATA AS HEX");
-    if config.chars {
-        print!("{:width$} {LINE_SEP_VERT} FOO", "", width = 37);
-    }
-    println!();
-    if config.chars {
-        println!("{}", format!("{LINE_SEP_HORIZ}").repeat(80));
-    } else {
-        println!("{}", format!("{LINE_SEP_HORIZ}").repeat(59));
-    }
-
-    // data dump loop
-    rd_data(data, &mut buf, &mut alt_buf, &mut byte_counter, &mut config)?;
-    while config.len > 0 {
-        print!("{:08X} {LINE_SEP_VERT} ", byte_counter);
-        for i in 0..config.len {
-            if i as usize % BYTES_PER_LINE == BYTES_PER_LINE / 2 {
-                print!(" ");
-            }
-            print!("{:02X} ", buf[alt_buf][i]);
-        }
-        if config.len == BYTES_PER_LINE / 2 {
-            print!(" ")
-        }
-        for i in 0..(BYTES_PER_LINE - config.len) {
-            if i as usize % BYTES_PER_LINE == BYTES_PER_LINE / 2 {
-                print!(" ");
-            }
-            print!("   ");
-        }
-        if config.chars {
-            print!("{LINE_SEP_VERT} |");
-            for i in 0..config.len {
-                print!("{}", mask_chars(buf[alt_buf][i] as char));
-            }
-            print!("|");
-        }
-        println!();
-
-        // loop breaker logic
-        if config.stop {
-            break;
-        }
-
-        // after line logic
-        rd_data(data, &mut buf, &mut alt_buf, &mut byte_counter, &mut config)?;
-        alt_buf ^= 1; // toggle the alt buf
-        if buf[0] == buf[1] && config.len == BYTES_PER_LINE && !config.show_identical {
-            trace!(buf = format!("{:?}", buf), "found a duplicating line");
-            let start_line = byte_counter;
-            while buf[0] == buf[1] && config.len == BYTES_PER_LINE {
-                rd_data(data, &mut buf, &mut alt_buf, &mut byte_counter, &mut config)?;
-                byte_counter += BYTES_PER_LINE;
-            }
-            println!(
-                "^^^^^^^^ {LINE_SEP_VERT} (repeats {} lines)",
-                byte_counter - start_line
-            );
-        }
-        // switch to the second half of the buf, the original half is stored the old buffer
-        // We detect duplicate lines with this
-        alt_buf ^= 1; // toggle the alt buf
-    }
-    Ok(())
-}
-
-fn mask_chars(c: char) -> char {
-    if c.is_ascii_graphic() {
-        return c;
-    } else if c == '\n' {
-        return '↩';
-    } else if c == ' ' {
-        return '␣';
-    } else if c == '\t' {
-        return '⭾';
-    } else {
-        return '<27>';
-    }
-}
-
-fn rd_data(
-    data: &mut dyn DataSource,
-    buf: &mut [[u8; BYTES_PER_LINE]; 2],
-    alt_buf: &mut usize,
-    byte_counter: &mut usize,
-    config: &mut HeduConfig,
-) -> Result<()> {
-    *byte_counter += config.len;
-    match data.read(&mut buf[*alt_buf]) {
-        Ok(mut len) => {
-            if config.limit != 0 && *byte_counter >= config.limit {
-                trace!(
-                    byte_counter,
-                    limit = config.limit,
-                    len,
-                    nlen = (config.limit % BYTES_PER_LINE),
-                    "byte counter is farther than limit"
-                );
-                len = config.limit % BYTES_PER_LINE;
-                config.stop = true;
-            }
-            config.len = len;
-            return Ok(());
-        }
-        Err(err) => {
-            error!("error while reading data: {err}");
-            bail!(err)
-        }
-    }
-}

members/libpt-bintols/src/join.rs

@@ -0,0 +1,50 @@
+//! # Join bits and bytes into numbers
+//!
+//! Sometimes you have a `[u8]` that is the representation of a larger unsigned integer, such as
+//! [u128]. This module helps you join them together.
+
+use anyhow::anyhow;
+use libpt_log::trace;
+
+/// Join a [Vec] of [u8]s into an unsigned integer
+///
+/// Say you have the array `[0b00000110, 0b10110101]` and want to use it as a [u32].
+/// This function sets it together to a integer type of your choosing:
+/// 1717 (binary: `00000000 00000000 00000110 10110101`).
+///
+/// If the array is not long enough, the number will be padded with null bytes.
+///
+/// # Examples
+///
+/// ```
+/// # use libpt_bintols::join::*;
+///
+/// let x: [u8; 2] = [0b00000110, 0b10110101];
+///
+/// assert_eq!(array_to_unsigned::<u32>(&x).unwrap(), 1717);
+/// ```
+pub fn array_to_unsigned<T>(parts: &[u8]) -> anyhow::Result<T>
+where
+    u128: std::convert::From<T>,
+    T: std::str::FromStr,
+    T: std::convert::TryFrom<u128>,
+    <T as std::str::FromStr>::Err: std::fmt::Debug,
+    <T as std::str::FromStr>::Err: std::error::Error,
+    <T as std::convert::TryFrom<u128>>::Error: std::error::Error,
+    <T as std::convert::TryFrom<u128>>::Error: std::marker::Send,
+    <T as std::convert::TryFrom<u128>>::Error: std::marker::Sync,
+    <T as std::convert::TryFrom<u128>>::Error: 'static,
+{
+    trace!("amount of parts: {}", parts.len());
+    if parts.len() > (u128::BITS / 8) as usize {
+        return Err(anyhow!(
+            "the list is too long to fit into the specified integer type: {}",
+            std::any::type_name::<T>()
+        ));
+    }
+    let mut ri: u128 = 0;
+    for (i, e) in parts.iter().rev().enumerate() {
+        ri += (*e as u128) * 256u128.pow(i as u32);
+    }
+    T::try_from(ri).map_err(anyhow::Error::from)
+}

members/libpt-bintols/src/lib.rs

@@ -25,4 +25,5 @@ pub const YOBI: u128 = 2u128.pow(80);
 // use libpt_core;
 pub mod datalayout;
 pub mod display;
-pub mod hedu;
+pub mod join;
+pub mod split;

members/libpt-bintols/src/split.rs

@@ -0,0 +1,38 @@
+//! # Split numbers into bits and bytes
+//!
+//! Sometimes, you need a large integer in the form of many bytes, so split into [u8].
+//! Rust provides
+
+/// Split unsigned integers into a [Vec] of [u8]s
+///
+/// Say you have the [u32] 1717 (binary: `00000000 00000000 00000110 10110101 `). This number would
+/// be splitted to `vec![0b00000110, 0b10110101]`.
+///
+/// The 0 bytes of the numbers will be discarded (unless the number is 0, then the Vec contains a
+/// single Null byte.) and the remaining parts of the numbers are inserted into a Vec as [u8].
+///
+/// # Examples
+///
+/// ```
+/// # use libpt_bintols::split::*;
+///
+/// let x: u32 = 1717;
+///
+/// assert_eq!(unsigned_to_vec(x), vec![0b00000110, 0b10110101]);
+/// ```
+pub fn unsigned_to_vec<T>(num: T) -> Vec<u8>
+where
+    u128: std::convert::From<T>,
+{
+    let mut num: u128 = num.into();
+    if num == 0 {
+        return vec![0];
+    }
+    let mut buf: Vec<u8> = Vec::new();
+    while num > 0 {
+        buf.push(num as u8);
+        num >>= 8;
+    }
+    buf.reverse();
+    buf
+}

members/libpt-bintols/tests/datalayout.rs

@@ -2,6 +2,6 @@ use libpt_bintols::*;
 
 #[test]
 fn mkdmp() {
-    let v = vec![true, true, false];
+    let v = [true, true, false];
     investigate_memory_layout!(bool, v);
 }

members/libpt-bintols/tests/display.rs

@@ -6,6 +6,10 @@ fn btobin() {
     let data = [19, 19];
     let r = bytes_to_bin(&data);
     assert_eq!(r, format!("0b00010011_00010011"));
+
+    let data = [0xff, 0xff];
+    let r = bytes_to_bin(&data);
+    assert_eq!(r, format!("0b11111111_11111111"));
 }
 
 #[test]
@@ -15,9 +19,7 @@ fn big_btobin() {
     assert_eq!(
         r,
         format!(
-            "0b00001100_00011111_01010010_\
-    00100000_01111011_00100000_01011100_00010111_00001100\n\
-    _00100000_00001100_00000001_00000001_00000001"
+            "0b00001100_00011111_01010010_00100000_01111011_00100000_01011100_00010111_00001100_00100000_00001100_00000001_00000001_00000001"
         )
     );
 }

members/libpt-bintols/tests/join.rs

@@ -0,0 +1,55 @@
+use libpt_bintols::join::*;
+
+#[test]
+fn join_u128() {
+    let correct = [
+        16,
+        255,
+        256,
+        0,
+        u128::MAX,
+        u64::MAX as u128,
+        u64::MAX as u128 + 1,
+    ];
+    let source = [
+        vec![16],
+        vec![255],
+        vec![1, 0],
+        vec![0],
+        vec![
+            255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+        ],
+        vec![255, 255, 255, 255, 255, 255, 255, 255],
+        vec![1, 0, 0, 0, 0, 0, 0, 0, 0],
+    ];
+    for (i, n) in source.iter().enumerate() {
+        assert_eq!(array_to_unsigned::<u128>(n).unwrap(), correct[i]);
+    }
+}
+
+#[test]
+fn join_u64() {
+    let correct = [
+        16,
+        255,
+        256,
+        0,
+        u64::MAX,
+        u32::MAX as u64,
+        0b1_00000001,
+        0b10011011_10110101_11110000_00110011,
+    ];
+    let source = [
+        vec![16],
+        vec![255],
+        vec![1, 0],
+        vec![0],
+        vec![255, 255, 255, 255, 255, 255, 255, 255],
+        vec![255, 255, 255, 255],
+        vec![1, 1],
+        vec![0b10011011, 0b10110101, 0b11110000, 0b00110011],
+    ];
+    for (i, n) in source.iter().enumerate() {
+        assert_eq!(array_to_unsigned::<u64>(n).unwrap(), correct[i]);
+    }
+}

members/libpt-bintols/tests/split.rs

@@ -0,0 +1,55 @@
+use libpt_bintols::split::*;
+
+#[test]
+fn split_u128() {
+    let source = [
+        16,
+        255,
+        256,
+        0,
+        u128::MAX,
+        u64::MAX as u128,
+        u64::MAX as u128 + 1,
+    ];
+    let correct = [
+        vec![16],
+        vec![255],
+        vec![1, 0],
+        vec![0],
+        vec![
+            255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+        ],
+        vec![255, 255, 255, 255, 255, 255, 255, 255],
+        vec![1, 0, 0, 0, 0, 0, 0, 0, 0],
+    ];
+    for (i, n) in source.iter().enumerate() {
+        assert_eq!(unsigned_to_vec(*n), correct[i]);
+    }
+}
+
+#[test]
+fn split_u64() {
+    let source = [
+        16,
+        255,
+        256,
+        0,
+        u64::MAX,
+        u32::MAX as u64,
+        0b1_00000001,
+        0b10011011_10110101_11110000_00110011,
+    ];
+    let correct = [
+        vec![16],
+        vec![255],
+        vec![1, 0],
+        vec![0],
+        vec![255, 255, 255, 255, 255, 255, 255, 255],
+        vec![255, 255, 255, 255],
+        vec![1, 1],
+        vec![0b10011011, 0b10110101, 0b11110000, 0b00110011],
+    ];
+    for (i, n) in source.iter().enumerate() {
+        assert_eq!(unsigned_to_vec(*n), correct[i]);
+    }
+}

members/libpt-cli/Cargo.toml

@@ -0,0 +1,37 @@
+[package]
+name = "libpt-cli"
+publish.workspace = true
+version = "0.2.2-alpha.2"
+edition.workspace = true
+authors.workspace = true
+license.workspace = true
+description.workspace = true
+readme.workspace = true
+homepage.workspace = true
+repository.workspace = true
+keywords.workspace = true
+categories.workspace = true
+
+[features]
+default = []
+full = ["log"]
+log = ["dep:log"]
+
+[dependencies]
+anyhow.workspace = true
+clap = { version = "4.5.7", features = ["derive"] }
+comfy-table = "7.1.1"
+console = "0.15.8"
+dialoguer = { version = "0.11.0", features = ["completion", "history"] }
+embed-doc-image = "0.1.4"
+indicatif = "0.17.8"
+libpt-log = { workspace = true, optional = false }
+log = { version = "0.4.21", optional = true }
+serde = { version = "1.0.209", features = ["derive"] }
+shlex = "1.3.0"
+strum = { version = "0.26.3", features = ["derive"] }
+thiserror.workspace = true
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

members/libpt-cli/examples/cli.rs

@@ -0,0 +1,38 @@
+use clap::Parser;
+use libpt_cli::args::VerbosityLevel;
+use libpt_cli::printing;
+use libpt_log::{debug, Logger};
+
+/// This is the help
+///
+/// This is more help
+#[derive(Parser, Debug)]
+struct Cli {
+    // already has documentation
+    #[command(flatten)]
+    verbosity: VerbosityLevel,
+
+    /// texts to be echoed
+    #[arg(required = true)]
+    text: Vec<String>,
+
+    /// try to be more machine readable
+    #[arg(short, long)]
+    machine: bool,
+}
+
+fn main() {
+    let cli = Cli::parse();
+    let _logger = Logger::builder().set_level(cli.verbosity.level()).build();
+
+    debug!("logger initialized with level: {}", cli.verbosity.level());
+
+    if !cli.machine {
+        let text = cli.text.join(" ");
+        printing::blockprint(text, console::Color::Green);
+    } else {
+        for text in cli.text {
+            println!("{text}")
+        }
+    }
+}

members/libpt-cli/examples/repl.rs

@@ -0,0 +1,82 @@
+use console::style;
+use libpt_cli::printing;
+use libpt_cli::repl::{DefaultRepl, Repl};
+use libpt_log::{debug, Logger};
+
+use clap::Subcommand;
+use strum::EnumIter;
+
+// this is where you define what data/commands/arguments the REPL accepts
+#[derive(Subcommand, Debug, EnumIter, Clone)]
+enum ReplCommand {
+    /// wait for LEN seconds
+    Wait {
+        /// wait so long
+        len: u64,
+    },
+    /// echo the given texts
+    Echo {
+        /// the text you want to print
+        text: Vec<String>,
+        /// print with a fancy border and colors
+        #[arg(short, long)]
+        fancy: bool,
+    },
+    /// hello world
+    Hello,
+    /// leave the repl
+    Exit,
+}
+
+fn main() -> anyhow::Result<()> {
+    // You would normally make a proper cli interface with clap before entering the repl. This is
+    // omitted here for brevity
+    let _logger = Logger::builder().display_time(false).build();
+
+    // the compiler can infer that we want to use the ReplCommand enum.
+    let mut repl = DefaultRepl::<ReplCommand>::default();
+
+    debug!("entering the repl");
+    loop {
+        // repl.step() should be at the start of your loop
+        // It is here that the repl will get the user input, validate it, and so on
+        match repl.step() {
+            Ok(c) => c,
+            Err(e) => {
+                // if the user requested the help, print in blue, otherwise in red as it's just an
+                // error
+                if let libpt_cli::repl::error::Error::Parsing(e) = &e {
+                    if e.kind() == clap::error::ErrorKind::DisplayHelp {
+                        println!("{}", style(e).cyan());
+                        continue;
+                    }
+                }
+                println!("{}", style(e).red().bold());
+                continue;
+            }
+        };
+
+        // now we can match our defined commands
+        //
+        // only None if the repl has not stepped yet
+        match repl.command().to_owned().unwrap() {
+            ReplCommand::Exit => break,
+            ReplCommand::Wait { len } => {
+                debug!("len: {len}");
+                let spinner = indicatif::ProgressBar::new_spinner();
+                spinner.enable_steady_tick(std::time::Duration::from_millis(100));
+                std::thread::sleep(std::time::Duration::from_secs(len));
+                spinner.finish();
+            }
+            ReplCommand::Hello => println!("Hello!"),
+            ReplCommand::Echo { text, fancy } => {
+                if !fancy {
+                    println!("{}", text.join(" "))
+                } else {
+                    printing::blockprint(text.join(" "), console::Color::Cyan)
+                }
+            }
+        }
+    }
+    Ok(())
+}

members/libpt-cli/src/args.rs

@@ -0,0 +1,281 @@
+//! Utilities for parsing options and arguments on the start of a CLI application
+
+use clap::Parser;
+use libpt_log::Level;
+#[cfg(feature = "log")]
+use log;
+use serde::{Deserialize, Serialize};
+
+/// Custom help template for displaying command-line usage information
+///
+/// This template modifies the default template provided by Clap to include additional information
+/// and customize the layout of the help message.
+///
+/// Differences from the default template:
+/// - Includes the application version and author information at the end
+///
+/// Apply like this:
+/// ```
+/// # use libpt_cli::args::HELP_TEMPLATE;
+/// use clap::Parser;
+/// #[derive(Parser, Debug, Clone, PartialEq, Eq, Hash)]
+/// #[command(help_template = HELP_TEMPLATE, author, version)]
+/// pub struct MyArgs {
+///     /// show more details
+///     #[arg(short, long)]
+///     pub verbose: bool,
+/// }
+/// ```
+///
+/// ## Example
+///
+/// Don't forget to set `authors` in your `Cargo.toml`!
+///
+/// ```bash
+/// $ cargo run -- -h
+/// about: short
+///
+/// Usage: aaa [OPTIONS]
+///
+/// Options:
+///   -v, --verbose  show more details
+///   -h, --help     Print help (see more with '--help')
+///   -V, --version  Print version
+///
+/// aaa: 0.1.0
+/// Author: Christoph J. Scherr <software@cscherr.de>
+///
+/// ```
+pub const HELP_TEMPLATE: &str = r"{about-section}
+{usage-heading} {usage}
+
+{all-args}{tab}
+
+{name}: {version}
+Author: {author-with-newline}
+";
+
+/// Transform -v and -q flags to some kind of loglevel
+///
+/// # Example
+///
+/// Include this into your [clap] derive struct like this:
+///
+/// ```
+/// use libpt_cli::args::VerbosityLevel;
+/// use clap::Parser;
+///
+/// #[derive(Parser, Debug)]
+/// pub struct Opts {
+///     #[command(flatten)]
+///     pub verbose: VerbosityLevel,
+///     #[arg(short, long)]
+///     pub mynum: usize,
+/// }
+///
+/// ```
+///
+/// Get the loglevel like this:
+///
+/// ```no_run
+/// use libpt_cli::args::VerbosityLevel;
+/// use libpt_log::Level;
+/// use clap::Parser;
+///
+/// # #[derive(Parser, Debug)]
+/// # pub struct Opts {
+/// #     #[command(flatten)]
+/// #     pub verbose: VerbosityLevel,
+/// # }
+///
+/// fn main() {
+///     let opts = Opts::parse();
+///
+///     // Level might be None if the user wants no output at all.
+///     // for the 'tracing' level:
+///     let level: Level = opts.verbose.level();
+/// }
+/// ```
+#[derive(Parser, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
+pub struct VerbosityLevel {
+    /// make the output more verbose
+    #[arg(
+        long,
+        short = 'v',
+        action = clap::ArgAction::Count, // NOTE: this forces u8 type for some reason
+        global = true,
+        // help = L::verbose_help(),
+        // long_help = L::verbose_long_help(),
+    )]
+    verbose: u8,
+
+    /// make the output less verbose
+    ///
+    /// ( -qqq for completely quiet)
+    #[arg(
+        long,
+        short = 'q',
+        action = clap::ArgAction::Count,
+        global = true,
+        conflicts_with = "verbose",
+    )]
+    quiet: u8,
+}
+
+impl VerbosityLevel {
+    /// true only if no verbose and no quiet was set (user is using defaults)
+    #[inline]
+    #[must_use]
+    #[allow(clippy::missing_const_for_fn)] // the values of self can change
+    pub fn changed(&self) -> bool {
+        self.verbose != 0 || self.quiet != 0
+    }
+    #[inline]
+    #[must_use]
+    fn value(&self) -> u8 {
+        Self::level_value(Level::INFO)
+            .saturating_sub((self.quiet).min(10))
+            .saturating_add((self.verbose).min(10))
+    }
+
+    /// get the [Level] for that [`VerbosityLevel`]
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use libpt_log::Level; // reexport: tracing
+    /// use libpt_cli::args::VerbosityLevel;
+    ///
+    /// let verbosity_level = VerbosityLevel::INFO;
+    /// assert_eq!(verbosity_level.level(), Level::INFO);
+    /// ```
+    #[inline]
+    #[must_use]
+    pub fn level(&self) -> Level {
+        let v = self.value();
+        match v {
+            0 => Level::ERROR,
+            1 => Level::WARN,
+            2 => Level::INFO,
+            3 => Level::DEBUG,
+            4 => Level::TRACE,
+            _ => {
+                if v > 4 {
+                    Level::TRACE
+                } else {
+                    /* v < 0 */
+                    Level::ERROR
+                }
+            }
+        }
+    }
+
+    /// get the [`log::Level`] for that `VerbosityLevel`
+    ///
+    /// This is the method for the [log] crate, which I use less often.
+    ///
+    /// [None] means that absolutely no output is wanted (completely quiet)
+    #[inline]
+    #[must_use]
+    #[cfg(feature = "log")]
+    pub fn level_for_log_crate(&self) -> log::Level {
+        match self.level() {
+            Level::TRACE => log::Level::Trace,
+            Level::DEBUG => log::Level::Debug,
+            Level::INFO => log::Level::Info,
+            Level::WARN => log::Level::Warn,
+            Level::ERROR => log::Level::Error,
+        }
+    }
+
+    #[inline]
+    #[must_use]
+    const fn level_value(level: Level) -> u8 {
+        match level {
+            Level::TRACE => 4,
+            Level::DEBUG => 3,
+            Level::INFO => 2,
+            Level::WARN => 1,
+            Level::ERROR => 0,
+        }
+    }
+
+    /// # Examples
+    ///
+    /// ```
+    /// use libpt_log::Level; // reexport: tracing
+    /// use libpt_cli::args::VerbosityLevel;
+    ///
+    /// let verbosity_level = VerbosityLevel::TRACE;
+    /// assert_eq!(verbosity_level.level(), Level::TRACE);
+    /// ```
+    pub const TRACE: Self = Self {
+        verbose: 2,
+        quiet: 0,
+    };
+    /// # Examples
+    ///
+    /// ```
+    /// use libpt_log::Level; // reexport: tracing
+    /// use libpt_cli::args::VerbosityLevel;
+    ///
+    /// let verbosity_level = VerbosityLevel::DEBUG;
+    /// assert_eq!(verbosity_level.level(), Level::DEBUG);
+    /// ```
+    pub const DEBUG: Self = Self {
+        verbose: 1,
+        quiet: 0,
+    };
+    /// # Examples
+    ///
+    /// ```
+    /// use libpt_log::Level; // reexport: tracing
+    /// use libpt_cli::args::VerbosityLevel;
+    ///
+    /// let verbosity_level = VerbosityLevel::INFO;
+    /// assert_eq!(verbosity_level.level(), Level::INFO);
+    /// ```
+    pub const INFO: Self = Self {
+        verbose: 0,
+        quiet: 0,
+    };
+    /// # Examples
+    ///
+    /// ```
+    /// use libpt_log::Level; // reexport: tracing
+    /// use libpt_cli::args::VerbosityLevel;
+    ///
+    /// let verbosity_level = VerbosityLevel::WARN;
+    /// assert_eq!(verbosity_level.level(), Level::WARN);
+    /// ```
+    pub const WARN: Self = Self {
+        verbose: 0,
+        quiet: 1,
+    };
+    /// # Examples
+    ///
+    /// ```
+    /// use libpt_log::Level; // reexport: tracing
+    /// use libpt_cli::args::VerbosityLevel;
+    ///
+    /// let verbosity_level = VerbosityLevel::ERROR;
+    /// assert_eq!(verbosity_level.level(), Level::ERROR);
+    /// ```
+    pub const ERROR: Self = Self {
+        verbose: 0,
+        quiet: 2,
+    };
+}
+
+impl std::fmt::Debug for VerbosityLevel {
+    #[inline]
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{:?}", self.level())
+    }
+}
+
+impl Default for VerbosityLevel {
+    fn default() -> Self {
+        Self::INFO
+    }
+}

members/libpt-cli/src/lib.rs

@@ -0,0 +1,6 @@
+//! This module bundles a lot of good CLI tools, and adds some of it's own, to make development of
+//! CLI apps easier and more ergonomic.
+#![warn(clippy::pedantic, clippy::style, clippy::nursery)]
+pub mod args;
+pub mod printing;
+pub mod repl;

members/libpt-cli/src/printing.rs

@@ -0,0 +1,145 @@
+//! Utilities for formatting, bordering, aligning and printing text content
+//!
+//! This module provides functions for formatting content with borders and colors, printing them to the console.
+//! The functions in this module are designed to simplify the process of creating visually appealing
+//! output for CLI applications.
+//!
+//! Note that most of the utilities in this module are focused on communication with humans, not
+//! with machines. Consider evaluating [`std::io::IsTerminal`] before using colorful, dynamic and bordered
+//! printing. If you are talking to a machine, it might be useful to not add extra space, add a
+//! newline per output or even output JSON. An example that does this well is `ls`:
+//!
+//! ```bash
+//! $ ls
+//! Cargo.lock  Cargo.toml  data  LICENSE  members  README.md  scripts  src  target
+//! ```
+//!
+//! ```bash
+//! $ ls | cat
+//! Cargo.lock
+//! Cargo.toml
+//! data
+//! LICENSE
+//! members
+//! README.md
+//! scripts
+//! src
+//! target
+//! ```
+//!
+//! See the [CLI Rustbook](https://rust-cli.github.io/book/in-depth/machine-communication.html) for
+//! more information on the topic.
+
+use comfy_table::presets;
+use comfy_table::{CellAlignment, ContentArrangement, Table};
+use console::{style, Color};
+
+/// Prints content with a simple border around it
+///
+/// This function is a convenience wrapper around [blockfmt] and [println]. It automatically
+/// formats the content with a border using the specified color and then prints it to the console.
+///
+/// # Example
+///
+/// ```
+/// use console::Color;
+/// use libpt_cli::printing::blockprint;
+/// # fn main() {
+/// blockprint("Hello world!", Color::Blue);
+/// # }
+/// ```
+#[inline]
+#[allow(clippy::needless_pass_by_value)] // we just take an impl, using a &impl is much less ergonomic
+pub fn blockprint(content: impl ToString, color: Color) {
+    println!("{}", blockfmt(content, color));
+}
+
+/// Formats content with a simple border around it
+///
+/// This function is a convenience wrapper around [`blockfmt_advanced`] with preset values for
+/// border style, content arrangement, and cell alignment. It automatically formats the content
+/// with a border as large as possible and centers the content. The resulting cell is colored in
+/// the specified color.
+///
+/// # Example
+///
+/// ```
+/// use console::Color;
+/// use libpt_cli::printing::blockfmt;
+/// # fn main() {
+/// let formatted_content = blockfmt("Hello world!", Color::Blue);
+/// println!("{}", formatted_content);
+/// # }
+/// ```
+#[inline]
+#[allow(clippy::needless_pass_by_value)] // we just take an impl, using a &impl is much less ergonomic
+pub fn blockfmt(content: impl ToString, color: Color) -> String {
+    blockfmt_advanced(
+        content,
+        Some(color),
+        presets::UTF8_BORDERS_ONLY,
+        ContentArrangement::DynamicFullWidth,
+        CellAlignment::Center,
+    )
+}
+
+/// Formats content with a border around it
+///
+/// Unless you are looking for something specific, use [blockfmt] or [blockprint].
+///
+/// The border can be created using box-drawing characters, and the content is formatted
+/// within the border. The function allows customization of the border's color, preset,
+/// content arrangement, and cell alignment.
+///
+/// # Example
+/// ```
+/// use comfy_table::{presets, CellAlignment, ContentArrangement};
+/// use console::Color;
+/// use libpt_cli::printing::blockfmt_advanced;
+/// # fn main() {
+/// println!(
+///     "{}",
+///     blockfmt_advanced(
+///         "Hello world!",
+///         Some(Color::Blue),
+///         presets::UTF8_FULL,
+///         ContentArrangement::DynamicFullWidth,
+///         CellAlignment::Center
+///     )
+/// );
+/// # }
+/// ```
+/// ```text
+/// ┌────────────────────────────────────────────────────────────────────────────────────────┐
+/// │                                      Hello world!                                      │
+/// └────────────────────────────────────────────────────────────────────────────────────────┘
+/// ```
+///
+/// # Parameters
+///
+/// - `content`: The content to be formatted within the border
+/// - `color`: The color of the border and text
+/// - `preset`: The preset style for the border
+/// - `arrangement`: The arrangement of the the border (e.g., stretch to sides, wrap around )
+/// - `alignment`: The alignment of the content within the cells (e.g., left, center, right)
+#[allow(clippy::missing_panics_doc)] // we add a row then unwrap it, no panic should be possible
+#[allow(clippy::needless_pass_by_value)] // we just take an impl, using a &impl is much less ergonomic
+pub fn blockfmt_advanced(
+    content: impl ToString,
+    color: Option<Color>,
+    preset: &str,
+    arrangement: ContentArrangement,
+    alignment: CellAlignment,
+) -> String {
+    let mut table = Table::new();
+    table
+        .load_preset(preset)
+        .set_content_arrangement(arrangement)
+        .add_row(vec![content.to_string()]);
+    table.column_mut(0).unwrap().set_cell_alignment(alignment);
+
+    match color {
+        Some(c) => format!("{}", style(table).fg(c)),
+        None => table.to_string(),
+    }
+}

members/libpt-cli/src/repl/default.rs

@@ -0,0 +1,217 @@
+//! This module implements a default repl that fullfills the [Repl] trait
+//!
+//! You can implement your own [Repl] if you want.
+
+use std::fmt::Debug;
+
+use super::Repl;
+
+use embed_doc_image::embed_doc_image;
+
+/// [clap] help template with only usage and commands/options
+pub const REPL_HELP_TEMPLATE: &str = r"{usage-heading} {usage}
+
+{all-args}{tab}
+";
+
+use clap::{Parser, Subcommand};
+use dialoguer::{BasicHistory, Completion};
+use libpt_log::trace;
+
+#[allow(clippy::needless_doctest_main)] // It makes the example look better
+/// Default implementation for a REPL
+///
+/// Note that you need to define the commands by yourself with a Subcommands enum.
+///
+/// # Example
+///
+/// ```no_run
+/// use libpt_cli::repl::{DefaultRepl, Repl};
+/// use clap::Subcommand;
+/// use strum::EnumIter;
+///
+/// #[derive(Subcommand, Debug, EnumIter, Clone)]
+/// enum ReplCommand {
+///     /// hello world
+///     Hello,
+///     /// leave the repl
+///     Exit,
+/// }
+///
+/// fn main() {
+///     let mut repl = DefaultRepl::<ReplCommand>::default();
+///     loop {
+///         repl.step().unwrap();
+///         match repl.command().to_owned().unwrap() {
+///             ReplCommand::Hello => println!("Hello"),
+///             ReplCommand::Exit => break,
+///             _ => (),
+///         }
+///     }
+/// }
+/// ```
+/// **Screenshot**
+///
+/// ![Screenshot of an example program with a REPL][repl_screenshot]
+#[embed_doc_image("repl_screenshot", "data/media/repl.png")]
+#[derive(Parser)]
+#[command(multicall = true, help_template = REPL_HELP_TEMPLATE)]
+#[allow(clippy::module_name_repetitions)] // we can't just name it `Default`, that's part of std
+pub struct DefaultRepl<C>
+where
+    C: Debug + Subcommand + strum::IntoEnumIterator,
+{
+    /// the command you want to execute, along with its arguments
+    #[command(subcommand)]
+    command: Option<C>,
+
+    // the following fields are not to be parsed from a command, but used for the internal workings
+    // of the repl
+    #[clap(skip)]
+    buf: String,
+    #[clap(skip)]
+    buf_preparsed: Vec<String>,
+    #[clap(skip)]
+    completion: DefaultReplCompletion<C>,
+    #[clap(skip)]
+    history: BasicHistory,
+}
+
+#[derive(Debug, Clone, Copy, Hash, Eq, PartialEq, PartialOrd, Ord)]
+struct DefaultReplCompletion<C>
+where
+    C: Debug + Subcommand + strum::IntoEnumIterator,
+{
+    commands: std::marker::PhantomData<C>,
+}
+
+impl<C> Repl<C> for DefaultRepl<C>
+where
+    C: Debug + Subcommand + strum::IntoEnumIterator,
+{
+    fn new() -> Self {
+        Self {
+            command: None,
+            buf_preparsed: Vec::new(),
+            buf: String::new(),
+            history: BasicHistory::new(),
+            completion: DefaultReplCompletion::new(),
+        }
+    }
+    fn command(&self) -> &Option<C> {
+        &self.command
+    }
+    fn step(&mut self) -> Result<(), super::error::Error> {
+        self.buf.clear();
+
+        // NOTE: display::Input requires some kind of lifetime that would be a bother to store in
+        // our struct. It's documentation also uses it in place, so it should be fine to do it like
+        // this.
+        //
+        // NOTE: It would be nice if we could use the Validator mechanism of dialoguer, but
+        // unfortunately we can only process our input after we've preparsed it and we need an
+        // actual output. If we could set a status after the Input is over that would be amazing,
+        // but that is currently not supported by dialoguer.
+        // Therefore, every prompt will show as success regardless.
+        self.buf = dialoguer::Input::with_theme(&dialoguer::theme::ColorfulTheme::default())
+            .completion_with(&self.completion)
+            .history_with(&mut self.history)
+            .interact_text()?;
+
+        self.buf_preparsed = Vec::new();
+        self.buf_preparsed
+            .extend(shlex::split(&self.buf).unwrap_or_default());
+
+        trace!("read input: {:?}", self.buf_preparsed);
+        trace!("repl after step: {:#?}", self);
+
+        // HACK: find a way to not allocate a new struct for this
+        let cmds = Self::try_parse_from(&self.buf_preparsed)?;
+        self.command = cmds.command;
+        Ok(())
+    }
+}
+
+impl<C> Default for DefaultRepl<C>
+where
+    C: Debug + Subcommand + strum::IntoEnumIterator,
+{
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl<C> Debug for DefaultRepl<C>
+where
+    C: Debug + Subcommand + strum::IntoEnumIterator,
+{
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.debug_struct("DefaultRepl")
+            .field("command", &self.command)
+            .field("buf", &self.buf)
+            .field("buf_preparsed", &self.buf_preparsed)
+            .field("completion", &self.completion)
+            .field("history", &"(no debug)")
+            .finish()
+    }
+}
+
+impl<C> DefaultReplCompletion<C>
+where
+    C: Debug + Subcommand + strum::IntoEnumIterator,
+{
+    /// Make a new [`DefaultReplCompletion`] for the type `C`
+    pub const fn new() -> Self {
+        Self {
+            commands: std::marker::PhantomData::<C>,
+        }
+    }
+    fn commands() -> Vec<String> {
+        let mut buf = Vec::new();
+        // every crate has the help command, but it is not part of the enum
+        buf.push("help".to_string());
+        for c in C::iter() {
+            // HACK: this is a horrible way to do this
+            // I just need the names of the commands
+            buf.push(
+                format!("{c:?}")
+                    .split_whitespace()
+                    .map(str::to_lowercase)
+                    .next()
+                    .unwrap()
+                    .to_string(),
+            );
+        }
+        trace!("commands: {buf:?}");
+        buf
+    }
+}
+
+impl<C> Default for DefaultReplCompletion<C>
+where
+    C: Debug + Subcommand + strum::IntoEnumIterator,
+{
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl<C> Completion for DefaultReplCompletion<C>
+where
+    C: Debug + Subcommand + strum::IntoEnumIterator,
+{
+    /// Simple completion implementation based on substring
+    fn get(&self, input: &str) -> Option<String> {
+        let matches = Self::commands()
+            .into_iter()
+            .filter(|option| option.starts_with(input))
+            .collect::<Vec<_>>();
+
+        trace!("\nmatches: {matches:#?}");
+        if matches.len() == 1 {
+            Some(matches[0].to_string())
+        } else {
+            None
+        }
+    }
+}

members/libpt-cli/src/repl/error.rs

@@ -0,0 +1,13 @@
+//! Errors for the Repl module
+
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum Error {
+    #[error(transparent)]
+    Parsing(#[from] clap::Error),
+    #[error(transparent)]
+    Input(#[from] dialoguer::Error),
+    #[error(transparent)]
+    Other(#[from] anyhow::Error),
+}

members/libpt-cli/src/repl/mod.rs

@@ -0,0 +1,48 @@
+//! Create easy and well defined REPLs
+//!
+//! A REPL is a [Read-Eval-Print-Loop](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop).
+//! Well known examples for REPLs are shells (like bash).
+//!
+//! This module offers a convenient way to create a well-defined REPL without a lot of complicated
+//! code and with a visually pleasing aesthetic. An example REPL implementation can be found in the
+//! examples.
+//!
+//! The basic idea is that the user defines the commands with an enum and uses [claps](clap)
+//! `#[derive(Subcommand)]`. A loop is then used to read from the stdin into a buffer, that buffer
+//! is put to [clap] for parsing, similar to how [clap] would parse commandline arguments.
+
+use std::fmt::Debug;
+
+pub mod error;
+use error::Error;
+mod default;
+pub use default::*;
+
+use clap::{Parser, Subcommand};
+
+/// Common Trait for repl objects
+///
+/// Unless you want to implement custom features (not just commands), just use [`DefaultRepl`].
+pub trait Repl<C>: Parser + Debug
+where
+    C: Debug + Subcommand + strum::IntoEnumIterator,
+{
+    /// create a new repl
+    fn new() -> Self;
+    /// get the command that was parsed from user input
+    ///
+    /// Will only be [None] if the repl has not had [step](Repl::step) executed yet.
+    fn command(&self) -> &Option<C>;
+    /// advance the repl to the next iteration of the main loop
+    ///
+    /// This should be used at the start of your loop.
+    ///
+    /// Note that the help menu is an Error: [`clap::error::ErrorKind::DisplayHelp`]
+    ///
+    /// # Errors
+    ///
+    /// * [`Error::Input`] – [dialoguer] User Input had some kind of I/O Error
+    /// * [`Error::Parsing`] – [clap] could not parse the user input, or user requested help
+    /// * [`Error::Other`] – Any other error with [anyhow], [`DefaultRepl`] does not use this but custom implementations might
+    fn step(&mut self) -> Result<(), Error>;
+}

members/libpt-core/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "libpt-core"
 publish.workspace = true
-version.workspace = true
+version = "0.5.0"
 edition.workspace = true
 authors.workspace = true
 license.workspace = true
@@ -14,5 +14,9 @@ categories.workspace = true
 
 [dependencies]
 anyhow = "1.0.79"
-cucumber = "0.20.2"
-libpt-log = { workspace = true }
+
+[dev-dependencies]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

members/libpt-core/src/lib.rs

@@ -6,33 +6,18 @@
 //! This crate implements core functionality useful for many use cases, such as macros,
 //! formatting functions and more.
 
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
 /// macros to make things faster in your code
 pub mod macros;
-/// some general use printing to stdout tools
-pub mod printing;
 
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////
+/// ## Get the name of the crate that uses your library
+///
+/// Let's say you're writing the library `foo` and need the name of the crate that uses `foo`. With
+/// this function, you can get the name of the crate that uses `foo`.
+///
+/// Will return [None] if [`std::env::current_exe()`] errors or if conversion to [String] from [std::ffi::OsStr] fails.
+pub fn get_crate_name() -> Option<String> {
+    if let Ok(exe) = std::env::current_exe() {
+        return Some(exe.file_stem()?.to_str()?.to_string());
+    }
+    None
+}

members/libpt-core/src/macros.rs

@@ -2,33 +2,14 @@
 //!
 //! This module implements macros for use with `libpt`.
 
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
 pub use crate::get_stdout_for;
 
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
 /// ## catches what the expression would write to the `stdout`
 ///
 /// This macro takes an expression, executes it, and catches what it would write to the stdout.
 /// The buffer of the stdout will then be returned for further use.
 ///
 /// This is especially useful when testing loggers or other frontend CLI functions.
-///
-/// Inspiration: [users.rust-lang.org](https://users.rust-lang.org/t/how-to-test-functions-that-use-println/67188/5)
 #[macro_export]
 macro_rules! get_stdout_for {
     ($test:expr) => {{
@@ -46,13 +27,3 @@ macro_rules! get_stdout_for {
         output
     }};
 }
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////

members/libpt-core/src/printing.rs

@@ -1,49 +0,0 @@
-//! # tools that make printing stuff better
-
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
-// reimport our macros to this module, so the user does not get confused when importing the macros
-pub use crate::divider;
-pub use crate::print_divider;
-
-//// TYPES /////////////////////////////////////////////////////////////////////////////////////////
-
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
-/// Quickly get a one line visual divider
-#[macro_export]
-macro_rules! divider {
-    () => {{
-        format!("{:=^80}", "=")
-    }};
-}
-
-////////////////////////////////////////////////////////////////////////////////////////////////////
-/// Quickly print a one line visual divider
-#[macro_export]
-macro_rules! print_divider {
-    () => {{
-        println!("{}", divider!())
-    }};
-}
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////

members/libpt-log/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "libpt-log"
 publish.workspace = true
-version.workspace = true
+version = "0.6.2-alpha.2"
 edition.workspace = true
 authors.workspace = true
 license.workspace = true
@@ -13,11 +13,17 @@ keywords.workspace = true
 categories.workspace = true
 
 [dependencies]
-tracing = "0.1.37"
-tracing-appender = "0.2.2"
-tracing-subscriber = "0.3.17"
+tracing = "0.1.40"
+tracing-appender = "0.2.3"
+tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
 anyhow = { workspace = true }
 thiserror = { workspace = true }
+libpt-core = { workspace = true, optional = false }
+chrono = "0.4.38"
 
 [dev-dependencies]
 gag = "1.0.0"
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

members/libpt-log/examples/logfile.rs

@@ -0,0 +1,11 @@
+use libpt_log::Logger;
+use tracing::info;
+
+fn main() {
+    let _logger = Logger::builder()
+        .log_to_file(true)
+        .log_dir("/tmp/llll".into())
+        .build()
+        .unwrap();
+    info!("foo bar qux");
+}

members/libpt-log/src/error.rs

@@ -2,70 +2,24 @@
 //!
 //! This module handles errors in logging contexts.
 
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
 use anyhow;
 use thiserror::Error;
 use tracing::subscriber::SetGlobalDefaultError;
-
-//// TYPES /////////////////////////////////////////////////////////////////////////////////////////
-
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
 /// ## Errors for the [Logger](super::Logger)
-#[derive(Error)]
+#[derive(Error, Debug)]
 pub enum Error {
     /// Bad IO operation
     #[error("Bad IO operation")]
-    IO(std::io::Error),
+    IO(#[from] std::io::Error),
     /// Various errors raised when the messenger is used in a wrong way
     #[error("Bad usage")]
     Usage(String),
     /// Could not assign logger as the global default
-    #[error("Could not assign as global default")] // TODO: make this more clear
-    SetGlobalDefaultFail(SetGlobalDefaultError),
+    #[error("Could not assign logger as global default")]
+    SetGlobalDefaultFail(#[from] SetGlobalDefaultError),
+    /// any other error type, wrapped in [`anyhow::Error`]
+    #[error(transparent)]
+    Other(#[from] anyhow::Error),
+    #[error("Tried to open the logfile, but logging to file was not requested")]
+    LogfileButNoFilelog,
 }
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-impl From<std::io::Error> for Error {
-    fn from(value: std::io::Error) -> Self {
-        Error::IO(value)
-    }
-}
-
-////////////////////////////////////////////////////////////////////////////////////////////////////
-impl From<SetGlobalDefaultError> for Error {
-    fn from(value: SetGlobalDefaultError) -> Self {
-        Error::SetGlobalDefaultFail(value)
-    }
-}
-
-////////////////////////////////////////////////////////////////////////////////////////////////////
-impl std::fmt::Debug for Error {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        match self {
-            Error::IO(e) => write!(f, "<IO Error {e:?}>"),
-            Error::Usage(e) => write!(f, "<Usage Error {e:?}>"),
-            Error::SetGlobalDefaultFail(e) => write!(f, "<SetGlobalDefaultFail {e:?}>"),
-        }
-    }
-}
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////

members/libpt-log/src/lib.rs

@@ -6,223 +6,406 @@
 //! For the library version, only the basic [`tracing`] is used, so that it is possible for
 //! the end user to use the [`tracing`] frontend they desire.
 //!
-//! I did however decide to create a [`Logger`] struct. This struct is mainly intended to be used
-//! with the python module of [`pt`](../libpt/index.html), but is still just as usable in other contexts.
+//! I did decide to create a [`Logger`] struct. This struct is mainly intended to be used with the
+//! python module of [`pt`](../libpt/index.html), but is still just as usable in other contexts.
+//! You can use this struct when use of the macros is not possible, but the macros should generally
+//! be preferred.
 //!
 //! ## Technologies used for logging:
 //! - [`tracing`]: base logging crate
 //! - [`tracing_appender`]: Used to log to files
 //! - [`tracing_subscriber`]: Used to do actual logging, formatting, to stdout
+#![warn(clippy::pedantic, clippy::style, clippy::nursery)]
 
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
 use std::{
-    fmt,
-    ops::Deref,
+    fmt::{self, Debug},
     path::PathBuf,
     sync::atomic::{AtomicBool, Ordering},
 };
 
 pub mod error;
-use error::*;
+use error::Error;
 
+/// This is the magic dependency where the cool stuff happens
+///
+/// I'm just repackaging it a little to make it more ergonomic
+pub use tracing;
 pub use tracing::{debug, error, info, trace, warn, Level};
-use tracing_appender::{
-    self,
-    non_blocking::{NonBlocking, WorkerGuard},
-};
 use tracing_subscriber::{
-    fmt::{
-        format::FmtSpan,
-        time::{self, FormatTime},
-    },
-    prelude::*,
+    fmt::format::FmtSpan, layer::SubscriberExt as _, util::SubscriberInitExt, Layer,
 };
 
 use anyhow::{bail, Result};
-
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
 /// The log level used when none is specified
 pub const DEFAULT_LOG_LEVEL: Level = Level::INFO;
 /// The path where logs are stored when no path is given.
 ///
 /// Currently, this is `/dev/null`, meaning they will be written to the void = discarded.
-pub const DEFAULT_LOG_DIR: &'static str = "/dev/null";
+pub const DEFAULT_LOG_DIR: &str = "/dev/null";
 
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
 static INITIALIZED: AtomicBool = AtomicBool::new(false);
 
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-/// ## Logger for [`pt`](../libpt/index.html)
+/// Builder for a well configured [Logger]
 ///
-/// This struct exists mainly for the python module, so that we can use the same logger with both
-/// python and rust.
-pub struct Logger;
+/// This struct helps configure a global logger that can be used with either macros or methods, see
+/// [Logger].
+///
+/// ## Examples
+///
+/// ```
+/// # use libpt_log::{Logger, info};
+/// # fn main() {
+/// Logger::builder()
+///     .uptime(true)
+///     .build();
+/// info!("hello world");
+/// # }
+///
+/// ```
+#[derive(PartialEq, Eq, PartialOrd, Ord, Debug)]
+#[allow(clippy::struct_excessive_bools)] // it's just true/false values, not states, and I don't
+                                         // need to reinvent the wheel
+pub struct LoggerBuilder {
+    /// create and log to logfiles
+    log_to_file: bool,
+    /// logfiles would be created here
+    log_dir: PathBuf,
+    /// use ANSI control sequences
+    ansi: bool,
+    /// show which source file produces a log
+    display_filename: bool,
+    /// show the log level of the message
+    display_level: bool,
+    /// show target context
+    display_target: bool,
+    /// sets the maximum verbosity level.
+    ///
+    /// For example, if set to [Error](Level::ERROR), logs at [Info](Level::INFO) will not be
+    /// printed. If set to [Debug](Level::DEBUG), logs at [Info](Level::INFO) will be printed.
+    max_level: Level,
+    /// show the id of the thread that created this message
+    display_thread_ids: bool,
+    /// show the name of the thread that created this message
+    display_thread_names: bool,
+    /// show which line in the source file produces a log
+    display_line_number: bool,
+    /// splits a log over multiple lines, looks like a python traceback
+    pretty: bool,
+    /// show when the log was created
+    show_time: bool,
+    /// show timestamps as uptime (duration since the logger was initialized)
+    uptime: bool,
+    /// log when span things happen
+    span_events: FmtSpan,
+}
 
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-/// ## Main implementation
-impl Logger {
-    /// ## create a `Logger`
+impl LoggerBuilder {
+    /// use the configured settings to build and initialize a new global [Logger]
     ///
-    /// Creates a new uninitialized [`Logger`] object.
-    pub fn new() -> Self {
-        let l = Logger {};
-        l
-    }
-    /// ## initializes the logger
+    /// This will build a functional [Logger]. You don't need to use the [Logger] struct, it's
+    /// better to use the macros:
     ///
-    /// Will enable the logger to be used.
+    /// * `error!`
+    /// * `warn!`
+    /// * `info!`
+    /// * `debug!`
+    /// * `trace!`
     ///
-    /// Assumes some defaults, use [`init_customized`](Self::init_customized) for more control
-    pub fn init(log_dir: Option<PathBuf>, max_level: Option<Level>) -> Result<()> {
-        Self::init_customized(
-            log_dir.is_some(),
-            log_dir.unwrap_or(PathBuf::from(DEFAULT_LOG_DIR)),
-            true,
-            false,
-            true,
-            false,
-            max_level.unwrap_or(DEFAULT_LOG_LEVEL),
-            false,
-            false,
-            false,
-            false,
-            true,
-            false,
-        )
-    }
-
-    /// ## initializes the logger
+    /// instead of the methods of the [Logger] struct. You can however use the [Logger] struct in
+    /// cases where usage of a macro is bad or you are somehow working with multiple loggers.
     ///
-    /// Will enable the logger to be used. This is a version that shows less information,
-    /// useful in cases with only one sender to the logging framework.
+    /// ## Examples
     ///
-    /// Assumes some defaults, use [`init_customized`](Self::init_customized) for more control
-    pub fn init_mini(max_level: Option<Level>) -> Result<()> {
-        Self::init_customized(
-            false,
-            PathBuf::from(DEFAULT_LOG_DIR),
-            true,
-            false,
-            true,
-            false,
-            max_level.unwrap_or(DEFAULT_LOG_LEVEL),
-            false,
-            false,
-            false,
-            false,
-            false,
-            false,
-        )
-    }
-
-    /// ## initializes the logger
+    /// ```
+    /// # use libpt_log::{Logger, info};
+    /// # fn main() {
+    /// Logger::builder()
+    ///     .uptime(true)
+    ///     .build();
+    /// info!("hello world");
+    /// # }
     ///
-    /// Will enable the logger to be used.
-    pub fn init_customized(
-        log_to_file: bool,
-        log_dir: PathBuf,
-        ansi: bool,
-        display_filename: bool,
-        display_level: bool,
-        display_target: bool,
-        max_level: Level,
-        display_thread_ids: bool,
-        display_thread_names: bool,
-        display_line_number: bool,
-        pretty: bool,
-        show_time: bool,
-        uptime: bool, // uptime instead of system time
-    ) -> Result<()> {
+    /// ```
+    /// # Errors
+    ///
+    /// This function will return an error if a global Logger was aready initialized. This module
+    /// uses the [tracing] crate for logging, so if a [tracing] logger is initialized elsewhere,
+    /// this method will error.
+    #[allow(clippy::missing_panics_doc)]
+    pub fn build(self) -> Result<Logger> {
         // only init if no init has been performed yet
         if INITIALIZED.load(Ordering::Relaxed) {
             warn!("trying to reinitialize the logger, ignoring");
-            bail!(Error::Usage(format!("logging is already initialized")));
+            bail!(Error::Usage("logging is already initialized".to_string()));
         }
-        let subscriber = tracing_subscriber::fmt::Subscriber::builder()
-            .with_level(display_level)
-            .with_max_level(max_level)
-            .with_ansi(ansi)
-            .with_target(display_target)
-            .with_file(display_filename)
-            .with_thread_ids(display_thread_ids)
-            .with_line_number(display_line_number)
-            .with_thread_names(display_thread_names)
-            .with_span_events(FmtSpan::FULL);
-        // I know this is hacky, but I couldn't get it any other way. I couldn't even find a
-        // project that could do it any other way. You can't apply one after another, because the
-        // type is changed every time. When using Box<dyn Whatever>, some methods complain about
-        // not being in trait bounds.
-        // TODO: somehow find a better solution for this
-        match (log_to_file, show_time, pretty, uptime) {
-            (true, true, true, true) => {
-                let subscriber = subscriber
-                    .with_writer(new_file_appender(log_dir))
-                    .with_timer(time::uptime())
-                    .pretty()
-                    .finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (true, true, true, false) => {
-                let subscriber = subscriber
-                    .with_writer(new_file_appender(log_dir))
-                    .pretty()
-                    .finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (true, false, true, _) => {
-                let subscriber = subscriber
-                    .with_writer(new_file_appender(log_dir))
-                    .without_time()
-                    .pretty()
-                    .finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (true, true, false, true) => {
-                let subscriber = subscriber
-                    .with_writer(new_file_appender(log_dir))
-                    .with_timer(time::uptime())
-                    .finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (true, true, false, false) => {
-                let subscriber = subscriber.with_writer(new_file_appender(log_dir)).finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (true, false, false, _) => {
-                let file_appender = tracing_appender::rolling::daily(log_dir.clone(), "log");
-                let (file_writer, _guard) = tracing_appender::non_blocking(file_appender);
-                let subscriber = subscriber.with_writer(file_writer).without_time().finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (false, true, true, true) => {
-                let subscriber = subscriber.pretty().with_timer(time::uptime()).finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (false, true, true, false) => {
-                let subscriber = subscriber.pretty().with_timer(time::uptime()).finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (false, false, true, _) => {
-                let subscriber = subscriber.without_time().pretty().finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (false, true, false, true) => {
-                let subscriber = subscriber.with_timer(time::uptime()).finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (false, true, false, false) => {
-                let subscriber = subscriber.finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
-            (false, false, false, _) => {
-                let subscriber = subscriber.without_time().finish();
-                tracing::subscriber::set_global_default(subscriber)?;
-            }
+        let layer = tracing_subscriber::fmt::layer()
+            .with_ansi(self.ansi)
+            .with_target(self.display_target)
+            .with_file(self.display_filename)
+            .with_thread_ids(self.display_thread_ids)
+            .with_line_number(self.display_line_number)
+            .with_thread_names(self.display_thread_names)
+            .with_span_events(self.span_events.clone())
+            .with_filter(tracing::level_filters::LevelFilter::from_level(
+                self.max_level,
+            ));
+        if self.log_to_file {
+            tracing_subscriber::registry()
+                .with(layer.and_then({
+                    tracing_subscriber::fmt::layer()
+                        .with_writer(
+                            self.logfile()?
+                                .expect("logging to file is requested but logfile returned None"),
+                        )
+                        .with_ansi(self.ansi)
+                        .with_target(self.display_target)
+                        .with_file(self.display_filename)
+                        .with_thread_ids(self.display_thread_ids)
+                        .with_line_number(self.display_line_number)
+                        .with_thread_names(self.display_thread_names)
+                        .with_span_events(self.span_events.clone())
+                        .with_filter(tracing::level_filters::LevelFilter::from_level(
+                            self.max_level,
+                        ))
+                }))
+                .init();
+        } else {
+            tracing_subscriber::registry().with(layer).init();
         }
+
         INITIALIZED.store(true, Ordering::Relaxed);
-        Ok(())
+        Ok(Logger {})
+    }
+
+    /// Opens a new file for logging to.
+    ///
+    /// Format: `{log_dir}/{consumer_name}_2024-09-01.log`
+    ///
+    /// Will be none if [`Self::log_to_file`] is [false].
+    fn logfile(&self) -> Result<Option<std::fs::File>> {
+        if !self.log_to_file {
+            return Err(Error::LogfileButNoFilelog.into());
+        }
+        let mut path = self.log_dir.clone();
+        std::fs::create_dir_all(&path)?;
+        path.push(format!(
+            "{}_{}.log",
+            libpt_core::get_crate_name().unwrap_or_else(|| "logfile".to_string()),
+            chrono::Local::now().date_naive()
+        ));
+        let file = std::fs::File::create(path)?;
+        Ok(Some(file))
+    }
+
+    /// enable or disable logging to and creating of logfiles
+    ///
+    /// If you want to log to a file, don't forget to set [`Self::log_dir`]!
+    ///
+    /// Default: false
+    #[must_use]
+    pub const fn log_to_file(mut self, log_to_file: bool) -> Self {
+        self.log_to_file = log_to_file;
+        self
+    }
+
+    /// set a directory where logfiles would be created in
+    ///
+    /// Enable or disable creation and logging to logfiles with [`log_to_file`](Self::log_to_file).
+    ///
+    /// Default: [`DEFAULT_LOG_DIR`] (/dev/null)
+    #[must_use]
+    pub fn log_dir(mut self, log_dir: PathBuf) -> Self {
+        self.log_dir = log_dir;
+        self
+    }
+
+    /// enable or disable ANSI control sequences
+    ///
+    /// Disabling ANSI control sequences might improve compatibility and readability when the logs
+    /// are displayed by a program that does not interpret them.
+    ///
+    /// Keeping ANSI control sequences enabled has the disadvantage of added colors for the logs.
+    ///
+    /// Default: true
+    #[must_use]
+    pub const fn ansi(mut self, ansi: bool) -> Self {
+        self.ansi = ansi;
+        self
+    }
+
+    /// when making a log, display the source file in which a log was crated in
+    ///
+    /// Default: false
+    #[must_use]
+    pub const fn display_filename(mut self, display_filename: bool) -> Self {
+        self.display_filename = display_filename;
+        self
+    }
+
+    /// when making a log, display the time of the message
+    ///
+    /// Default: true
+    #[must_use]
+    pub const fn display_time(mut self, show_time: bool) -> Self {
+        self.show_time = show_time;
+        self
+    }
+
+    /// when making a log, display the log level of the message
+    ///
+    /// Default: true
+    #[must_use]
+    pub const fn display_level(mut self, display_level: bool) -> Self {
+        self.display_level = display_level;
+        self
+    }
+
+    /// show target context
+    ///
+    /// Default: false
+    #[must_use]
+    pub const fn display_target(mut self, display_target: bool) -> Self {
+        self.display_target = display_target;
+        self
+    }
+
+    /// show the id of the thread that created this message
+    ///
+    /// Default: false
+    #[must_use]
+    pub const fn display_thread_ids(mut self, display_thread_ids: bool) -> Self {
+        self.display_thread_ids = display_thread_ids;
+        self
+    }
+
+    /// show the name of the thread that created this message
+    ///
+    /// Default: false
+    #[must_use]
+    pub const fn display_thread_names(mut self, display_thread_names: bool) -> Self {
+        self.display_thread_names = display_thread_names;
+        self
+    }
+
+    /// show which line in the source file produces a log
+    ///
+    /// Default: false
+    #[must_use]
+    pub const fn display_line_number(mut self, display_line_number: bool) -> Self {
+        self.display_line_number = display_line_number;
+        self
+    }
+
+    /// splits a log over multiple lines, looks like a python traceback
+    ///
+    /// Default: false
+    #[must_use]
+    pub const fn pretty(mut self, pretty: bool) -> Self {
+        self.pretty = pretty;
+        self
+    }
+
+    /// show timestamps as uptime (duration since the logger was initialized)
+    ///
+    /// Default: false
+    #[must_use]
+    pub const fn uptime(mut self, uptime: bool) -> Self {
+        self.uptime = uptime;
+        self
+    }
+
+    /// set the lowest loglevel to be displayed
+    ///
+    /// Default: [`Level::INFO`]
+    #[must_use]
+    pub const fn set_level(mut self, max_level: Level) -> Self {
+        self.max_level = max_level;
+        self
+    }
+
+    /// set how span events are handled
+    ///
+    /// Default: [`FmtSpan::NONE`]
+    #[must_use]
+    pub const fn span_events(mut self, span_events: FmtSpan) -> Self {
+        self.span_events = span_events;
+        self
+    }
+}
+
+impl Default for LoggerBuilder {
+    fn default() -> Self {
+        Self {
+            log_to_file: false,
+            log_dir: PathBuf::from(DEFAULT_LOG_DIR),
+            ansi: true,
+            display_filename: false,
+            display_level: true,
+            display_target: false,
+            max_level: DEFAULT_LOG_LEVEL,
+            display_thread_ids: false,
+            display_thread_names: false,
+            display_line_number: false,
+            pretty: false,
+            show_time: true,
+            uptime: false,
+            span_events: FmtSpan::NONE,
+        }
+    }
+}
+
+/// ## Logger for `libpt`
+///
+/// A logger is generally a functionality that let's you write information from your library or
+/// application in a more structured manner than if you just wrote all information to `stdout` or
+/// `stderr` with the likes of `println!` or `eprintln!`.
+///
+/// It offers writing to multiple targets, such as both the terminal and a log file, and allows
+/// users to choose the verbosity of the information that gets printed by selecting a
+/// [Loglevel](Level).
+///
+/// ## Levels
+///
+/// * [ERROR](Level::ERROR) – Something broke
+/// * [WARN](Level::WARN) – Something is bad
+/// * [INFO](Level::INFO) – Useful information for users
+/// * [DEBUG](Level::DEBUG) – Useful information for developers
+/// * [TRACE](Level::TRACE) – Very verbose information for developers (often for libraries)
+///
+/// ## Usage
+///
+/// You don't need to use the [Logger] struct, it's better to use the macros instead:
+///
+/// * [`error!`]
+/// * [`warn!`]
+/// * [`info!`]
+/// * [`debug!`]
+/// * [`trace!`]
+///
+/// You can however use the [Logger] struct in cases where usage of a macro is impossible or
+/// you are somehow working with multiple loggers. The macros offer additional functionalities,
+/// suck as full `format!` support and context, see [`tracing`], which we use as backend.
+///
+/// ## Examples
+///
+/// ```
+/// # use libpt_log::{Logger, info};
+/// # fn main() {
+/// Logger::builder()
+///     .uptime(true)
+///     .build();
+/// info!("hello world");
+/// # }
+///
+/// ```
+pub struct Logger;
+
+/// ## Main implementation
+impl Logger {
+    /// Get a new [`LoggerBuilder`]
+    #[must_use]
+    pub fn builder() -> LoggerBuilder {
+        LoggerBuilder::default()
     }
 
     /// ## logging at [`Level::ERROR`]
@@ -230,39 +413,38 @@ impl Logger {
     where
         T: fmt::Display,
     {
-        error!("{}", printable)
+        error!("{}", printable);
     }
     /// ## logging at [`Level::WARN`]
     pub fn warn<T>(&self, printable: T)
     where
         T: fmt::Display,
     {
-        warn!("{}", printable)
+        warn!("{}", printable);
     }
     /// ## logging at [`Level::INFO`]
     pub fn info<T>(&self, printable: T)
     where
         T: fmt::Display,
     {
-        info!("{}", printable)
+        info!("{}", printable);
     }
     /// ## logging at [`Level::DEBUG`]
     pub fn debug<T>(&self, printable: T)
     where
         T: fmt::Display,
     {
-        debug!("{}", printable)
+        debug!("{}", printable);
     }
     /// ## logging at [`Level::TRACE`]
     pub fn trace<T>(&self, printable: T)
     where
         T: fmt::Display,
     {
-        trace!("{}", printable)
+        trace!("{}", printable);
     }
 }
 
-////////////////////////////////////////////////////////////////////////////////////////////////////
 impl fmt::Debug for Logger {
     /// ## DEBUG representation for [`Logger`]
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
@@ -274,10 +456,10 @@ impl fmt::Debug for Logger {
     }
 }
 
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////
-fn new_file_appender(log_dir: PathBuf) -> NonBlocking {
-    let file_appender = tracing_appender::rolling::daily(log_dir.clone(), "log");
-    return tracing_appender::non_blocking(file_appender).0;
+impl Default for Logger {
+    fn default() -> Self {
+        LoggerBuilder::default()
+            .build()
+            .expect("building a Logger failed")
+    }
 }

members/libpt-math/Cargo.toml

@@ -1,21 +0,0 @@
-[package]
-name = "libpt-math"
-publish.workspace = true
-version.workspace = true
-edition.workspace = true
-authors.workspace = true
-license.workspace = true
-description.workspace = true
-readme.workspace = true
-homepage.workspace = true
-repository.workspace = true
-keywords.workspace = true
-categories.workspace = true
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-num = "0.4.1"
-num-traits = "0.2.16"
-libpt-core = { workspace = true }
-libpt-log = { workspace = true }

members/libpt-math/src/ccc/mod.rs

@@ -1,41 +0,0 @@
-//! # Calculate expressions
-//!
-//! This crate is part of [`pt`](../libpt/index.html), but can also be used as a standalone
-//! module.
-//!
-//! Calculate Calculations with your Calculator (`ccc`)
-//!
-//! This modules aim is to take a term of any kind ([String]) and calculate it's value, be it
-//! variable based or a concrete numerical value. It implements different operators and
-//! (mathematical) functions.
-
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// TYPES /////////////////////////////////////////////////////////////////////////////////////////
-
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////
-
-////////////////////////////////////////////////////////////////////////////////////////////////////

members/libpt-math/src/lib.rs

@@ -1,38 +0,0 @@
-//! # General Mathmatics functionalities
-//!
-//! This crate is part of [`pt`](../libpt/index.html), but can also be used as a standalone
-//! module.
-//!
-//! This module is currently empty, but will contain many math functionalities in a future version.
-
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
-pub mod ccc;
-
-//// TYPES /////////////////////////////////////////////////////////////////////////////////////////
-
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////
-
-////////////////////////////////////////////////////////////////////////////////////////////////////

members/libpt-net/Cargo.toml

@@ -1,24 +0,0 @@
-[package]
-name = "libpt-net"
-publish.workspace = true
-version.workspace = true
-edition.workspace = true
-authors.workspace = true
-license.workspace = true
-description.workspace = true
-readme.workspace = true
-homepage.workspace = true
-repository.workspace = true
-keywords.workspace = true
-categories.workspace = true
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-humantime = "2.1.0"
-libpt-core = { workspace = true }
-libpt-log = { workspace = true }
-libpt-math = { workspace = true }
-reqwest = { version = "0.11.20", features = ["blocking"] }
-serde = { version = "1.0.188", features = ["serde_derive"] }
-serde_json = "1.0.107"

members/libpt-net/src/lib.rs

@@ -1,40 +0,0 @@
-//! # various networking tools
-//!
-//! This crate is part of [`pt`](../libpt/index.html), but can also be used as a standalone
-//! module.
-//!
-//! The networking module contains various tools related to connections. For example, it contains a
-//! tool that has the purpose to check if your connection is consistently available.
-
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
-/// monitor your connection
-pub mod monitoring;
-
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-/// how long to wait for a remove server to respond in ms
-pub const DEFAULT_REQUEST_TIMEOUT: u64 = 2000;
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////

members/libpt-net/src/monitoring/mod.rs

@@ -1,33 +0,0 @@
-//! # monitor your network
-//!
-//! This module offers functions to monitor your network.
-
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
-pub mod uptime;
-
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////

members/libpt-net/src/monitoring/uptime.rs

@@ -1,275 +0,0 @@
-//! # monitor your network uptime
-//!
-//! This method offers a way to monitor your networks/hosts uptime. This is achieved by making
-//! HTTPS requests to a given list of
-//!
-//! Warning: This module is not unit tested.
-
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-use std::{fmt, time::Duration};
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
-use libpt_log::*;
-
-use reqwest;
-
-use humantime::{format_duration, format_rfc3339};
-use std::time::SystemTime;
-
-use serde::{Deserialize, Serialize};
-use serde_json;
-
-use libpt_core::divider;
-
-//// TYPES /////////////////////////////////////////////////////////////////////////////////////////
-
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-/// urls used for checking by default
-pub const DEFAULT_CHECK_URLS: &'static [&'static str] =
-    &["https://www.cscherr.de", "https://www.cloudflare.com"];
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-/// ## Describes an uptime status
-///
-/// [`UptimeStatus`] describes the result of an uptime check.
-#[derive(Serialize, Deserialize)]
-pub struct UptimeStatus {
-    /// true if the [`UptimeStatus`] is considered successful
-    pub success: bool,
-    /// the percentage of reachable urls out of the total urls
-    pub success_ratio: u8,
-    /// the percentage of reachable urls out of the total urls that need to be reachable in order
-    /// for this [`UptimeStatus`] to be considered a success.
-    pub success_ratio_target: u8,
-    /// the number of reachable [`urls`](UptimeStatus::urls)
-    pub reachable: usize,
-    /// which urls to check in [`check()`](UptimeStatus::check)
-    pub urls: Vec<String>,
-    /// timeout length for requests (in ms)
-    pub timeout: u64,
-}
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-/// Main implementation
-impl UptimeStatus {
-    /// ## create a new `UptimeStatus` and perform it's check
-    pub fn new(success_ratio_target: u8, urls: Vec<String>, timeout: u64) -> Self {
-        assert!(success_ratio_target <= 100);
-        let mut status = UptimeStatus {
-            success: false,
-            success_ratio: 0,
-            success_ratio_target,
-            reachable: 0,
-            urls,
-            timeout,
-        };
-        status.urls.dedup();
-
-        status.check();
-
-        return status;
-    }
-
-    /// ## check for success with the given urls
-    ///
-    /// Makes the actual https requests and updates fields accordingly.
-    ///
-    /// Note: Blocking execution for all requests, timeout is set to
-    /// [REQUEST_TIMEOUT](crate::networking::REQUEST_TIMEOUT).
-    pub fn check(&mut self) {
-        self.reachable = 0;
-        self.urls.iter().for_each(|url| {
-            let client = reqwest::blocking::Client::builder()
-                .timeout(Duration::from_millis(self.timeout))
-                .build()
-                .expect("could not build a client for https requests");
-            let response = client.get(url.clone()).send();
-            if response.is_ok() {
-                self.reachable += 1
-            }
-        });
-        self.calc_success();
-    }
-
-    /// ## calculate the success based on the `reachable` and `total`
-    ///
-    /// Calculates the ratio of [`reachable`](UptimeStatus::reachable) /
-    /// (length of [urls](UptimeStatus::urls)).
-    ///
-    /// Calculates a [`success_ratio`](UptimeStatus::success_ratio) (as [u8]) from that,
-    /// by multiplying with 100, then flooring.
-    ///
-    /// If the [`success_ratio`](UptimeStatus::success_ratio) is greater than or equal to the
-    /// [`success_ratio_target`](UptimeStatus::success_ratio_target), the [`UptimeStatus`] will be
-    /// considered a success.
-    ///
-    /// In the special case that no URLs to check for have been provided, the check will be
-    /// considered a success, but the [`success_ratio`](UptimeStatus::success_ratio) will be `0`.
-    ///
-    /// Note: does not check for networking, use [`check()`](UptimeStatus::check) for that.
-    pub fn calc_success(&mut self) {
-        // if no urls need to be checked, success without checking
-        if self.urls.len() == 0 {
-            self.success = true;
-            self.success_ratio = 0;
-            return;
-        }
-        let ratio: f32 = (self.reachable as f32) / (self.urls.len() as f32) * 100f32;
-        trace!("calculated success_ratio: {}", ratio);
-        self.success_ratio = ratio.floor() as u8;
-        self.success = self.success_ratio >= self.success_ratio_target;
-        trace!("calculated success as: {}", self.success)
-    }
-}
-
-////////////////////////////////////////////////////////////////////////////////////////////////////
-impl fmt::Debug for UptimeStatus {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        let mut urls: Vec<&str> = Vec::new();
-        for url in &self.urls {
-            urls.push(url.as_str());
-        }
-        write!(f, "{}", serde_json::to_string(self).unwrap())
-    }
-}
-
-////////////////////////////////////////////////////////////////////////////////////////////////////
-impl fmt::Display for UptimeStatus {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        let mut urls: Vec<&str> = Vec::new();
-        for url in &self.urls {
-            urls.push(url.as_str());
-        }
-        write!(f, "{}", serde_json::to_string_pretty(self).unwrap())
-    }
-}
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-/// ## Uptime monitor
-///
-/// This function continuously monitors the uptime of your host/network.
-///
-/// On change of status, an update will be logged at [INFO Level](log::Level::Info), containing
-/// information on your current status, including timestamps of the last up/down time and durations
-/// since.
-pub fn continuous_uptime_monitor(
-    success_ratio_target: u8,
-    urls: Vec<String>,
-    interval: u64,
-    timeout: u64,
-) {
-    if urls.len() == 0 {
-        error!("No URLs provided. There is nothing to monitor.");
-        return;
-    }
-
-    let interval = std::time::Duration::from_millis(interval);
-    let mut last_downtime: Option<SystemTime> = None;
-    let mut last_uptime: Option<SystemTime> = None;
-    let mut status = UptimeStatus::new(success_ratio_target, urls, timeout);
-    // we assume that the last status was up, so the binary shows the first status if its a
-    // failure.
-    let mut last_was_up: bool = true;
-    let mut last_ratio: u8 = status.success_ratio;
-    loop {
-        trace!(
-            ?status,
-            ?last_was_up,
-            "loop iteration for continuous uptime monitor"
-        );
-        if !status.success {
-            if last_was_up {
-                trace!("displaying status");
-                display_uptime_status("fail", last_uptime, last_downtime, &status)
-            }
-            last_downtime = Some(SystemTime::now());
-            last_was_up = false;
-        } else if status.success_ratio < 100 {
-            if status.success_ratio != last_ratio {
-                let msg = format!(
-                    "uptime check: not all urls are reachable ({}%)",
-                    status.success_ratio
-                );
-                display_uptime_status(&msg, last_uptime, last_downtime, &status)
-            }
-            last_uptime = Some(SystemTime::now());
-            last_was_up = true;
-        } else {
-            if !last_was_up {
-                display_uptime_status("success", last_uptime, last_downtime, &status)
-            }
-            last_uptime = Some(SystemTime::now());
-            last_was_up = true;
-        }
-
-        last_ratio = status.success_ratio;
-        std::thread::sleep(interval);
-        status.check();
-    }
-}
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////
-/// Displays the current status for the [continuous uptime monitor](continuous_uptime_monitor)
-fn display_uptime_status(
-    msg: &str,
-    last_uptime: Option<SystemTime>,
-    last_downtime: Option<SystemTime>,
-    status: &UptimeStatus,
-) {
-    // I know it's weird that this has two spaces too much, but somehow just the tabs is missing
-    // two spaces.
-    info!("uptime check:      {}", msg);
-    info!("last uptime:       {}", match_format_time(last_uptime));
-    info!("last downtime:     {}", match_format_time(last_downtime));
-    info!(
-        "since downtime:    {}",
-        match_format_duration_since(last_downtime)
-    );
-    info!(
-        "since uptime:      {}",
-        match_format_duration_since(last_uptime)
-    );
-    debug!("\n{}", status);
-    info!("{}", divider!());
-}
-
-////////////////////////////////////////////////////////////////////////////////////////////////////
-/// Returns "None" if the given [Option] is [None](Option::None). Otherwise, returns the time stamp
-/// formatted according to rfc3999.
-fn match_format_time(time: Option<SystemTime>) -> String {
-    match time {
-        Some(time) => format_rfc3339(time).to_string(),
-        None => String::from("None"),
-    }
-}
-
-////////////////////////////////////////////////////////////////////////////////////////////////////
-/// Returns "None" if the given [Option] is [None](Option::None). Otherwise, returns duration since
-/// that time in a human readable format.
-fn match_format_duration_since(time: Option<SystemTime>) -> String {
-    match time {
-        Some(time) => format_duration(
-            SystemTime::now()
-                .duration_since(time)
-                .expect("could not calculate elapsed time"),
-        )
-        .to_string(),
-        None => String::from("None"),
-    }
-}

publish.sh

@@ -1,8 +0,0 @@
-#!/bin/bash
-set -e
-PKGs=(libpt-{core,math,log,net,bintols,ccc,hedu,bin,py} libpt)
-for PKG in "${PKGs[@]}"; do
-	echo "Package: $PKG"
-	cargo publish --registry cscherr -p "$PKG"
-	cargo publish -p "$PKG"
-done

scripts/publish.sh

@@ -1,3 +1,20 @@
 #!/bin/bash
 set -e
-cargo ws publish --registry cscherr || cargo publish --registry cscherr -p libpt
+cargo check --all-features --workspace
+echo ">>>>>>>> SELECT A NEW VERSION"
+cargo ws version
+NEW_VERSION=$(cat Cargo.toml | rg '^\s*version\s*=\s*"([^"]*)"\s*$' -or '$1')
+echo ">>>>>>>> PUBLISHING RELEASE FOR REPO"
+bash scripts/release.sh
+echo ">>>>>>>> PUBLISHING TO CRATES.IO NEXT"
+sleep 10
+cargo publish -p libpt-log
+cargo publish -p libpt-core
+cargo publish -p libpt-bintols
+cargo publish -p libpt
+echo ">>>>>>>> PUBLISHING TO CSCHERR.DE NEXT"
+sleep 3
+cargo publish --registry cscherr -p libpt-log
+cargo publish --registry cscherr -p libpt-core
+cargo publish --registry cscherr -p libpt-bintols
+cargo publish --registry cscherr -p libpt

scripts/release.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+TOKEN=$(cat ~/.git-credentials | grep 'git.cscherr.de' | grep -P '(?:)[^:]*(?=@)' -o)
+NEW_VERSION=$(cat Cargo.toml | rg '^\s*version\s*=\s*"([^"]*)"\s*$' -or '$1')
+VERSION=$(git rev-parse HEAD)
+GIT_COMMIT_SHA=$(git rev-parse HEAD)
+BODY="
+$(git log $(git describe --tags --abbrev=0)..HEAD --pretty="- %s" --oneline --decorate)
+"
+USER=PlexSheep
+git tag "v$NEW_VERSION" || echo "could not tag"
+curl -X 'POST' \
+	'https://git.cscherr.de/api/v1/repos/PlexSheep/pt/releases' \
+	-H 'accept: application/json' \
+	-H "Authorization: token $TOKEN" \
+	-H 'Content-Type: application/json' \
+	-d '{
+  "body": "'"$BODY"'",
+  "draft": false,
+  "name": "v'$NEW_VERSION'",
+  "prerelease": true,
+  "tag_name": "v'$NEW_VERSION'",
+  "target_commitish": "'$GIT_COMMIT_SHA'"
+}' | python -m json.tool
+git push || echo "could not push"

scripts/set_all_versions.sh

@@ -1,6 +0,0 @@
-#!/bin/bash
-export NEW_VER=$1
-pwd
-sed -i 's/\(^\s*version\)\s*=\s*"\([^"]*\)"$/\1 = "'$NEW_VER'"/g' Cargo.toml
-find * -name 'Cargo.toml' -type f \
-    -exec sed -i 's/\(libpt.*version\s*=\s*\)"[^"]*"/\1"'$NEW_VER'"/g' Cargo.toml {} +

src/ccc/mod.rs

@@ -1,104 +0,0 @@
-//! # Executable for the math/compute submodule
-//!
-//! Calculate Calculations with your Computer!
-//!
-//! This command line tool allows you to input a mathematical expression. It will then process the
-//! expression.
-
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
-
-use libpt::log::*;
-
-use clap::Parser;
-use clap_verbosity_flag::{InfoLevel, Verbosity};
-
-//// TYPES /////////////////////////////////////////////////////////////////////////////////////////
-
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-/// short about section displayed in help
-const ABOUT_ROOT: &'static str = r##"
-Calculate Calculations with your Computer
-
-    This commandline tool allows you to calculate complex mathematical expressions right in your
-    shell.
-"##;
-/// longer about section displayed in help, is combined with [the short help](ABOUT_ROOT)
-static LONG_ABOUT_ROOT: &'static str = r##"
-
-    libpt is a personal general purpose library, offering this executable, a python module and a
-    dynamic library.
-"##;
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-/// defines CLI interface
-#[derive(Debug, Clone, Parser)]
-#[command(
-    author,
-    version,
-    about = ABOUT_ROOT,
-    long_about = format!("{}{}", ABOUT_ROOT ,LONG_ABOUT_ROOT),
-    help_template =
-r#"libpt: {version}{about-section}Author:
-{author-with-newline}
-{usage-heading} {usage}{all-args}{tab}"#
-    )]
-pub struct Cli {
-    // clap_verbosity_flag seems to make this a global option implicitly
-    /// set a verbosity, multiple allowed (f.e. -vvv)
-    #[command(flatten)]
-    pub verbose: Verbosity<InfoLevel>,
-
-    /// show logger meta
-    #[arg(short, long, global = true)]
-    pub log_meta: bool,
-
-    /// your exporession(s)
-    #[clap(trailing_var_arg = true)]
-    pub expression: Vec<String>,
-}
-
-//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////
-fn main() {
-    let cli = Cli::parse();
-    let ll: Level = match cli.verbose.log_level().unwrap().as_str() {
-        "TRACE" => Level::TRACE,
-        "DEBUG" => Level::DEBUG,
-        "INFO" => Level::INFO,
-        "WARN" => Level::WARN,
-        "ERROR" => Level::ERROR,
-        _ => {
-            eprintln!("'{}' is not a valid loglevel", cli.verbose.to_string());
-            std::process::exit(1);
-        }
-    };
-    if cli.log_meta {
-        Logger::init(None, Some(ll)).expect("could not initialize Logger");
-    } else {
-        // less verbose version
-        Logger::init_mini(Some(ll)).expect("could not initialize Logger");
-    }
-    let mut expr: String = String::new();
-    for part in cli.expression {
-        expr += &part;
-    }
-}
-////////////////////////////////////////////////////////////////////////////////////////////////////

src/hedu/mod.rs

@@ -1,151 +0,0 @@
-//! # Executable for the hedu submodule
-//!
-//! Dump data to a fancy format.
-
-//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
-// we want docs
-#![warn(missing_docs)]
-#![warn(rustdoc::missing_crate_level_docs)]
-// we want Debug everywhere.
-#![warn(missing_debug_implementations)]
-// enable clippy's extra lints, the pedantic version
-#![warn(clippy::pedantic)]
-
-//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
-
-use libpt::{bintols::hedu::*, log::*};
-
-use clap::Parser;
-use clap_verbosity_flag::{InfoLevel, Verbosity};
-
-use std::{fs::File, io::IsTerminal};
-
-//// TYPES /////////////////////////////////////////////////////////////////////////////////////////
-
-//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
-/// short about section displayed in help
-const ABOUT_ROOT: &'static str = r##"
-Dumps data in fancy formats.
-"##;
-/// longer about section displayed in help, is combined with [the short help](ABOUT_ROOT)
-static LONG_ABOUT_ROOT: &'static str = r##"
-
-    libpt is a personal general purpose library, offering this executable, a python module and a
-    dynamic library.
-"##;
-
-//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
-
-//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
-
-//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
-
-//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
-/// defines CLI interface
-#[derive(Debug, Clone, Parser)]
-#[command(
-    author,
-    version,
-    about = ABOUT_ROOT,
-    long_about = format!("{}{}", ABOUT_ROOT ,LONG_ABOUT_ROOT),
-    help_template =
-r#"{about-section}
-{usage-heading} {usage}
-{all-args}{tab}
-
-libpt: {version}
-Author: {author-with-newline}
-"#
-    )]
-pub struct Cli {
-    // clap_verbosity_flag seems to make this a global option implicitly
-    /// set a verbosity, multiple allowed (f.e. -vvv)
-    #[command(flatten)]
-    pub verbose: Verbosity<InfoLevel>,
-
-    /// show additional logging meta data
-    #[arg(long)]
-    pub meta: bool,
-
-    /// show character representation
-    #[arg(short, long)]
-    pub chars: bool,
-
-    /// skip first N bytes
-    #[arg(short, long, default_value_t = 0)]
-    pub skip: usize,
-
-    /// only interpret N bytes (end after N)
-    #[arg(short, long, default_value_t = 0)]
-    pub limit: usize,
-
-    /// show identical lines
-    #[arg(short = 'i', long)]
-    pub show_identical: bool,
-
-    /// a data source, probably a file.
-    ///
-    /// If left empty or set as "-", the program will read from stdin.
-    pub data_source: Option<String>,
-}
-
-//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
-
-//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
-
-//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////
-fn main() {
-    let cli = cli_parse();
-    let mut source: Box<dyn DataSource>;
-    if cli.data_source.is_some() && cli.data_source.clone().is_some_and(|val| val != "-") {
-        let data_source = cli.data_source.unwrap();
-        trace!("Trying to open '{}'", data_source);
-        source = match File::open(&data_source) {
-            Ok(file) => Box::new(file),
-            Err(err) => {
-                error!("Could not open file '{}': {err}", data_source);
-                std::process::exit(1);
-            }
-        };
-    } else {
-        trace!("Trying to open stdout");
-        let stdin = std::io::stdin();
-        if stdin.is_terminal() {
-            warn!("Refusing to dump from interactive terminal");
-            std::process::exit(2)
-        }
-        source = Box::new(stdin);
-    }
-
-    match dump(
-        &mut *source,
-        HeduConfig::new(cli.chars, cli.skip, cli.show_identical, cli.limit),
-    ) {
-        Ok(_) => (),
-        Err(err) => {
-            error!("Could not dump data of file: {err}");
-            std::process::exit(3);
-        }
-    }
-}
-////////////////////////////////////////////////////////////////////////////////////////////////////
-fn cli_parse() -> Cli {
-    let cli = Cli::parse();
-    let ll: Level = match cli.verbose.log_level().unwrap().as_str() {
-        "TRACE" => Level::TRACE,
-        "DEBUG" => Level::DEBUG,
-        "INFO" => Level::INFO,
-        "WARN" => Level::WARN,
-        "ERROR" => Level::ERROR,
-        _ => {
-            unreachable!();
-        }
-    };
-    if cli.meta {
-        Logger::init(None, Some(ll)).expect("could not initialize Logger");
-    } else {
-        // less verbose version
-        Logger::init_mini(Some(ll)).expect("could not initialize Logger");
-    }
-    return cli;
-}

src/lib.rs

@@ -5,16 +5,13 @@
 //!
 //! `pt` is a project consisting of multiple smaller crates, all bundled together in this
 //! "main crate". Most crates will only show up if you activate their feature.
-
+#![warn(clippy::pedantic, clippy::style, clippy::nursery)]
+#[cfg_attr(docsrs, doc(cfg(feature = "full")))]
 #[cfg(feature = "bintols")]
 pub use libpt_bintols as bintols;
-#[cfg(feature = "ccc")]
-pub use libpt_ccc as ccc;
+#[cfg(feature = "cli")]
+pub use libpt_cli as cli;
 #[cfg(feature = "core")]
 pub use libpt_core as core;
 #[cfg(feature = "log")]
 pub use libpt_log as log;
-#[cfg(feature = "math")]
-pub use libpt_math as math;
-#[cfg(feature = "net")]
-pub use libpt_net as net;