Metadata-Version: 2.1
Name: ntfy-send
Version: 0.3.0
Summary: Client application for ntfy.sh
Home-page: https://git.goral.net.pl/mgoral/ntfy-send
License: GPLv3
Author: Michal Goral
Author-email: dev@goral.net.pl
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Utilities
Requires-Dist: requests (>=2.28.1,<3.0.0)
Requires-Dist: tomlkit (>=0.11.6,<0.12.0)
Project-URL: Repository, https://git.goral.net.pl/mgoral/ntfy-send
Description-Content-Type: text/markdown

# ntfy-send

ntfy-send is a client application for notification service
[ntfy.sh](https://ntfy.sh).

## Configuration

ntfy-send can be configured via a configuration file. It is recommended
method of storing your credential informations, which simplifies obtaining
and sending them to ntfy server.

All configuration options can be enclosed in backticks (`). When this is the
case, the option is treated as a command whose output substitutes the
configurration option.

Configuration files are stored in _$XDG_CONFIG_HOME/ntfy-send/config.toml_.
If you don't have _$XDG_CONFIG_HOME_ environment variale set, then it is
stored in _~/.config/ntfy-send/config.toml_. Below are documented all
options:

```toml
# config.toml

# URL to the server
server = "https://ntfy.sh"

# Username and password can be automatically obtained each time they're
# required. This is done by passing commands which should echo credentials.
# For complex commands it's recommended to pot them in a separate script, due
# to problems with several levels of quote escaping

# Username and password can be passed in plain text. This isn't recommended.
username = "user"
password = "pass"

# Alternatively, ntfy-send can automatically run a command for username and
# password when they're enclosed in backticks (`):
username = """`gpg2 --decrypt pass.gpg | awk -F ":" '/user:/ { printf $2 }'`"""
password = """`gpg2 --decrypt pass.gpg | awk -F ":" '/password:/ { printf $2 }'`"""
```


