rv-script-utils

Script utilities to add in structured logging and support for healthchecks.io. See example of use in hello.py and in the example below.

from typing import Self

from rv_script_lib import ScriptBase


class HelloWorld(ScriptBase):

    PARSER_ARGPARSE_KWARGS = {
        "description": "Hello World",
    }

    def extraArgs(self: Self):

        self.parser.add_argument(
            "-m",
            "--message",
            type=str,
            dest="message",
            default="you forgot to add a message with -m/--message",
            help="What do you want to say?",
        )

    def runJob(self: Self):

        self.log.info("Hello from rv-script-utils!")

        try:
            raise RuntimeError("This is just a test")
        except Exception as e:
            self.log.exception(e)

        self.log.warning("Warning, just for fun")

        self.log.info(self.args.message)


if __name__ == "__main__":

    myscript = HelloWorld()
    myscript.run()

Development Status
- 3 - Alpha
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Programming Language
- Python :: 3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rv_script_utils-0.2.1.tar.gz (22.4 kB view details)

Uploaded Dec 27, 2024 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

rv_script_utils-0.2.1-py3-none-any.whl (8.9 kB view details)

Uploaded Dec 27, 2024 Python 3

File details

Details for the file rv_script_utils-0.2.1.tar.gz.

File metadata

Download URL: rv_script_utils-0.2.1.tar.gz
Upload date: Dec 27, 2024
Size: 22.4 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for rv_script_utils-0.2.1.tar.gz
Algorithm	Hash digest
SHA256	`81acaf7a692808b894386e911220541aadb12b4e17918f4c33e375c8aae9b4cd`
MD5	`97926b82dbe6b4a14b53a882252f73b0`
BLAKE2b-256	`bc81b3588d3b00879e2de878cc9e8f45de7dcdf9c1a95165528ab5d3f85315b1`

See more details on using hashes here.

Provenance

The following attestation bundles were made for rv_script_utils-0.2.1.tar.gz:

Publisher: python-package.yml on rveachkc/rv-script-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: rv_script_utils-0.2.1.tar.gz
- Subject digest: 81acaf7a692808b894386e911220541aadb12b4e17918f4c33e375c8aae9b4cd
- Sigstore transparency entry: 157919264
- Sigstore integration time: Dec 27, 2024
Source repository:
- Permalink: rveachkc/rv-script-utils@3b602bee125982015082ec14abbc7dc52b26c075
- Branch / Tag: refs/tags/v0.2.1
- Owner: https://github.com/rveachkc
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: python-package.yml@3b602bee125982015082ec14abbc7dc52b26c075
- Trigger Event: push