libranet / sitecustomize-hello

Demo-plugin for sitecustomize-entrypoints

https://app.codecov.io/gh/libranet/sitecustomize-hello

sitecustomize-hello

How does it work?

We register the sitecustomize_help.entrypoint()-function to the sitecustomize-module that is installed by the sitecustomize-entrypoints-package.

The registered function will print "Hello" to the standard output.

Installation

Install via pip:

> bin/pip install sitecustomize-hello

Or add to your poetry-based project:

> poetry add sitecustomize-hello

Validate & Usage

After installing this package there is nothing left to do explicitly. We can validate that the plugin work correctly by starting a python-session and checking the hello-message being printed:

> bin/python

bin/python
Hello.
   >>> (interactive python-shell)

bin/ipython
Hello.
   >>> (interactive ipython-shell)

bin/black
Hello.
(black output)

bin/pytest
Hello.
(pytest output)

Registered sitecustomize-entrypoint

The sitecustomize_hello-function is registered as a sitecustomize-entrypoint in our pyproject.toml_:

    [tool.poetry.plugins]
    [tool.poetry.plugins."sitecustomize"]
    sitecustomize_hello = "sitecustomize_hello:entrypoint"

Sitecustomize and all its registered entrypoints will be executed at the start of every python-process. For more information, please see sitecustomize-entrypoints

Compatibility

sitecustomize-hello works on Python 3.8+, including PyPy3. Tested until Python 3.11,

Notable dependencies

• sitecustomize-entrypoints