Prowlpy
Python library to interface with the Prowl API.
Installation
Prowlpy is installable as a library to be used within scripts or apps or with a CLI to send messages from the command line.
To install user/system wide use pip install prowlpy otherwise add it as normal to your pyproject.toml or requirements.txt
The CLI is not installed by default. You can include it when installing. Using uv you would use this command:
uv tool install prowlpy[cli]
Usage
Prowlpy can be used in multiple ways.
library
Sync or Async
Both sync and async versions of the library are available. To use async, replace Prowl with AsyncProwl
Sending messages
from prowlpy import Prowl
apikey = "1234567890123456789012345678901234567890"
p = Prowl(apikey=apikey)
p.send(application="Test App", event="Test Event", description="The testing event has failed")
Prowlpy can also be used within a context manager:
from prowlpy import Prowl
apikey = "1234567890123456789012345678901234567890"
with Prowl(apikey=apikey) as p:
p.send(application="Test App", event="Test Event", description="The testing event has failed")
Verify API key(s)
Prowlpy can also be used to verify an API key before sending a message or as a testing step like this:
from prowlpy import Prowl
apikey = "1234567890123456789012345678901234567890"
p = Prowl(apikey=apikey)
p.verify_key()
If the key is not valid or an error occurs an APIError Exception will be raised.
Generate API Key(s)
Prowlpy can be used to generate API keys for users if you have a valid providerkey with a process similar to this:
from prowlpy import Prowl
providerkey = "0987654321098765432109876543210987654321"
p = Prowl(providerkey=providerkey)
token_response = p.retrieve_token()
print(token_response["url"])
The user that the key is being created for will need to fillow the link provided and accept then the key can be created on the account with:
...
apikey_respose = p.retrieve_apikey(token=token_response["token"])
print(apikey_response["apikey"])
CLI
The CLI can be used to send massages via Prowl like this:
prowlpy --apikey="1234567890123456789012345678901234567890" --application="Test App" --event="Testing" --description="This is a test message"
Metadata
Release files for prowlpy 2.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| prowlpy-2.0.1.tar.gz | 26.4 kB | Without provenance | Details for prowlpy-2.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| prowlpy-2.0.1-py3-none-any.whl | Python 3 | none | any | Details for prowlpy-2.0.1-py3-none-any.whl |
Total release size: 47.9 kB
Release files / prowlpy-2.0.1.tar.gz
| Download URL | prowlpy-2.0.1.tar.gz |
|---|---|
| Size | 26.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
224512ef418acf9e5c1cfd71d90db6982fb60bec01df116df9b61cb5e0688e55
|
|
BLAKE2b-256 checksum How to use checksums |
cb72fce88271914bcb99242ef300cc61aab3ecd4210c1929cdbf031548b728f6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / prowlpy-2.0.1-py3-none-any.whl
| Download URL | prowlpy-2.0.1-py3-none-any.whl |
|---|---|
| Size | 21.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7b61a3b2fcf1858680da8ee446e1014a670bd6c57c4d946c2ff80e81c323f364
|
|
BLAKE2b-256 checksum How to use checksums |
b934a7b1ce4054a63702d4b89bd9c73903ce69b2754f5b9123d2d5456735f8ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for prowlpy 2.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.