python-ntfy 0.3.6__tar.gz → 0.3.8__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {python_ntfy-0.3.6 → python_ntfy-0.3.8}/PKG-INFO +14 -20
- {python_ntfy-0.3.6 → python_ntfy-0.3.8}/README.md +12 -16
- {python_ntfy-0.3.6 → python_ntfy-0.3.8}/pyproject.toml +5 -3
- {python_ntfy-0.3.6 → python_ntfy-0.3.8}/LICENSE +0 -0
- {python_ntfy-0.3.6 → python_ntfy-0.3.8}/python_ntfy/__init__.py +0 -0
- {python_ntfy-0.3.6 → python_ntfy-0.3.8}/python_ntfy/_get_functions.py +0 -0
- {python_ntfy-0.3.6 → python_ntfy-0.3.8}/python_ntfy/_send_functions.py +0 -0
|
@@ -1,20 +1,18 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: python-ntfy
|
|
3
|
-
Version: 0.3.
|
|
3
|
+
Version: 0.3.8
|
|
4
4
|
Summary: An ntfy library aiming for feature completeness
|
|
5
5
|
Home-page: https://github.com/MatthewCane/python-ntfy
|
|
6
6
|
License: MIT
|
|
7
7
|
Author: Matthew Cane
|
|
8
8
|
Author-email: matthew.cane0@gmail.com
|
|
9
|
-
Requires-Python: >=3.
|
|
9
|
+
Requires-Python: >=3.12,<=3.13
|
|
10
10
|
Classifier: Development Status :: 4 - Beta
|
|
11
11
|
Classifier: Intended Audience :: Developers
|
|
12
12
|
Classifier: License :: OSI Approved :: MIT License
|
|
13
13
|
Classifier: Programming Language :: Python :: 3
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
15
14
|
Classifier: Programming Language :: Python :: 3.12
|
|
16
15
|
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
-
Requires-Dist: mypy (>=1.12.0,<2.0.0)
|
|
18
16
|
Requires-Dist: requests (>=2.31.0,<3.0.0)
|
|
19
17
|
Project-URL: Documentation, https://matthewcane.github.io/python-ntfy/
|
|
20
18
|
Project-URL: Repository, https://github.com/MatthewCane/python-ntfy
|
|
@@ -22,9 +20,9 @@ Description-Content-Type: text/markdown
|
|
|
22
20
|
|
|
23
21
|
# A Python Library For ntfy
|
|
24
22
|
|
|
25
|
-
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
28
26
|
|
|
29
27
|
An easy-to-use python library for the [ntfy notification service](https://ntfy.sh/). Aiming for full feature support and a super easy to use interface.
|
|
30
28
|
|
|
@@ -71,12 +69,15 @@ See the full documentation site at [https://matthewcane.github.io/python-ntfy/](
|
|
|
71
69
|
|
|
72
70
|
This project uses:
|
|
73
71
|
|
|
74
|
-
- Poetry as it's dependency manager
|
|
75
|
-
- Ruff for linting and code formatting
|
|
76
|
-
- MyPy for static type checking
|
|
72
|
+
- [Poetry](https://python-poetry.org/) as it's dependency manager
|
|
73
|
+
- [Ruff](https://docs.astral.sh/ruff/) for linting and code formatting
|
|
74
|
+
- [MyPy](https://mypy-lang.org/) for static type checking
|
|
75
|
+
- [Pre-Commit](https://pre-commit.com/) for running the above tools before committing
|
|
77
76
|
|
|
78
77
|
To install dev dependencies, run `poetry install --with dev`.
|
|
79
78
|
|
|
79
|
+
To install pre-commit hooks, run `pre-commit install`.
|
|
80
|
+
|
|
80
81
|
### Linting, Formatting and Type Checking
|
|
81
82
|
|
|
82
83
|
These can be run with:
|
|
@@ -91,17 +92,10 @@ These tools are also run in the CI pipeline and must pass before merging.
|
|
|
91
92
|
|
|
92
93
|
This project is aiming for 95% code coverage. Any added features must include comprihensive tests.
|
|
93
94
|
|
|
94
|
-
You can run the tests against a local instance of `ntfy` *or* `ntfy.sh`.
|
|
95
|
-
|
|
96
95
|
#### Setup Steps
|
|
97
96
|
|
|
98
|
-
1.
|
|
99
|
-
|
|
100
|
-
ii. Set the following key in the `.env` file: `NTFY_SERVER=http://localhost`
|
|
101
|
-
iii. Add a dummy username and password to `.env` (see example.env)
|
|
102
|
-
2. To test against `https://ntfy.sh`:
|
|
103
|
-
i. Add username and password for ntfy.sh to `.env` (see example.env)
|
|
104
|
-
3. Run the tests with `poetry run pytest --cov`
|
|
97
|
+
1. Start the test docker container with `docker-compose -f tests/assets/test_containers.yml up`
|
|
98
|
+
2. Run the tests with `poetry run pytest --cov`
|
|
105
99
|
|
|
106
|
-
The tests will sent messages to the `python_ntfy_testing` topic so you will need to subcribe to that topic to see the test messages.
|
|
100
|
+
The tests will sent messages to the `python_ntfy_testing` topic so you will need to view the web interface and subcribe to that topic to see the test messages.
|
|
107
101
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# A Python Library For ntfy
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
6
|
|
|
7
7
|
An easy-to-use python library for the [ntfy notification service](https://ntfy.sh/). Aiming for full feature support and a super easy to use interface.
|
|
8
8
|
|
|
@@ -49,12 +49,15 @@ See the full documentation site at [https://matthewcane.github.io/python-ntfy/](
|
|
|
49
49
|
|
|
50
50
|
This project uses:
|
|
51
51
|
|
|
52
|
-
- Poetry as it's dependency manager
|
|
53
|
-
- Ruff for linting and code formatting
|
|
54
|
-
- MyPy for static type checking
|
|
52
|
+
- [Poetry](https://python-poetry.org/) as it's dependency manager
|
|
53
|
+
- [Ruff](https://docs.astral.sh/ruff/) for linting and code formatting
|
|
54
|
+
- [MyPy](https://mypy-lang.org/) for static type checking
|
|
55
|
+
- [Pre-Commit](https://pre-commit.com/) for running the above tools before committing
|
|
55
56
|
|
|
56
57
|
To install dev dependencies, run `poetry install --with dev`.
|
|
57
58
|
|
|
59
|
+
To install pre-commit hooks, run `pre-commit install`.
|
|
60
|
+
|
|
58
61
|
### Linting, Formatting and Type Checking
|
|
59
62
|
|
|
60
63
|
These can be run with:
|
|
@@ -69,16 +72,9 @@ These tools are also run in the CI pipeline and must pass before merging.
|
|
|
69
72
|
|
|
70
73
|
This project is aiming for 95% code coverage. Any added features must include comprihensive tests.
|
|
71
74
|
|
|
72
|
-
You can run the tests against a local instance of `ntfy` *or* `ntfy.sh`.
|
|
73
|
-
|
|
74
75
|
#### Setup Steps
|
|
75
76
|
|
|
76
|
-
1.
|
|
77
|
-
|
|
78
|
-
ii. Set the following key in the `.env` file: `NTFY_SERVER=http://localhost`
|
|
79
|
-
iii. Add a dummy username and password to `.env` (see example.env)
|
|
80
|
-
2. To test against `https://ntfy.sh`:
|
|
81
|
-
i. Add username and password for ntfy.sh to `.env` (see example.env)
|
|
82
|
-
3. Run the tests with `poetry run pytest --cov`
|
|
77
|
+
1. Start the test docker container with `docker-compose -f tests/assets/test_containers.yml up`
|
|
78
|
+
2. Run the tests with `poetry run pytest --cov`
|
|
83
79
|
|
|
84
|
-
The tests will sent messages to the `python_ntfy_testing` topic so you will need to subcribe to that topic to see the test messages.
|
|
80
|
+
The tests will sent messages to the `python_ntfy_testing` topic so you will need to view the web interface and subcribe to that topic to see the test messages.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[tool.poetry]
|
|
2
2
|
name = "python-ntfy"
|
|
3
|
-
version = "0.3.
|
|
3
|
+
version = "0.3.8"
|
|
4
4
|
description = "An ntfy library aiming for feature completeness"
|
|
5
5
|
authors = ["Matthew Cane <matthew.cane0@gmail.com>"]
|
|
6
6
|
readme = "README.md"
|
|
@@ -10,14 +10,16 @@ documentation = "https://matthewcane.github.io/python-ntfy/"
|
|
|
10
10
|
classifiers = [
|
|
11
11
|
"Development Status :: 4 - Beta",
|
|
12
12
|
"Intended Audience :: Developers",
|
|
13
|
+
"Programming Language :: Python :: 3.12",
|
|
14
|
+
"Programming Language :: Python :: 3.13",
|
|
13
15
|
]
|
|
14
16
|
|
|
15
17
|
[tool.poetry.dependencies]
|
|
16
|
-
python = "
|
|
18
|
+
python = ">=3.12, <=3.13"
|
|
17
19
|
requests = "^2.31.0"
|
|
18
|
-
mypy = "^1.12.0"
|
|
19
20
|
|
|
20
21
|
[tool.poetry.group.dev.dependencies]
|
|
22
|
+
mypy = "^1.12.0"
|
|
21
23
|
pytest = ">=7.4.1,<9.0.0"
|
|
22
24
|
python-dotenv = "^1.0.0"
|
|
23
25
|
pytest-asyncio = ">=0.21.1,<0.25.0"
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|