Metadata-Version: 2.1
Name: pushnotifier
Version: 1.3.0
Summary: A python package for easy interaction with https://pushnotifier.de/
Home-page: https://github.com/tomg404/pushnotifier-python
Author: Tom Gaimann
Author-email: tom.gaimann+pushnotifier@outlook.com
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

# PushNotifier (V2) for Python

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pushnotifier.svg)
![PyPI version](https://badge.fury.io/py/pushnotifier.svg)
![build](https://img.shields.io/github/actions/workflow/status/tomg404/pushnotifier-python/python-package.yml?branch=master)
![Documentation Status](https://readthedocs.org/projects/pushnotifier-python/badge/?version=latest)
![GitHub](https://img.shields.io/github/license/tomg404/pushnotifier-python.svg)
![GitHub repo size](https://img.shields.io/github/repo-size/tomg404/pushnotifier-python.svg)

A python module to easily use the service of [PushNotifier](https://pushnotifier.de) in your python projects.

You can find the documentation [here](https://pushnotifier-python.readthedocs.io/en/latest/).

## About
Easily send

-   messages ✉️
-   urls 🌎
-   images 🖼️

via python to all your devices. For more info visit [pushnotifier.de](https://pushnotifier.de)

## Installation
-   Install PushNotifier via pip
    ```console
    $ pip install pushnotifier
    ```

-   Install PushNotifier manually
    ```console
    $ git clone https://github.com/tomg404/pushnotifier-python
    $ cd /path/to/repository/
    $ python setup.py install
    ```

## Usage
```python
from pushnotifier import PushNotifier

pn = PushNotifier('username', 'password', 'package_name', 'api_key')
```

### Sending messages
```python
>>> pn.send_text('hello world', silent=False, devices=['abcd', 'efgh'])
>>> pn.send_url('https://www.example.com', silent=False, devices=['abcd', 'efgh'])
>>> pn.send_notification('hello world', 'https://www.example.com', silent=False, devices=['abcd', 'efgh'])

>>> # Note on send_image: currently you can't send images to android/ios devices
>>> pn.send_image('path/to/image.png', silent=False, devices=['abcd', 'efgh'])
```

### Get Basic information
```python
>>> password = 'XXXXX'
>>> pn.login(password)
{'username': 'username', 'avatar': 'https://gravatar.com/avatar/XXXXX', 'app_token': 'XXXXX', 'expires_at': XXXXX}

>>> pn.get_all_devices()
['abcd', 'efgh', 'ijkl']
```

### Refresh app token
```python
>> > pn.refresh_token()
'new_token'
```

### More detailed help
See the [documentation](https://pushnotifier-python.readthedocs.io/en/latest/) or
```python
>>> help(pn.some_method_you_need_help_on)
```
