python-ntfy 0.5.1__tar.gz → 0.5.2__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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: python-ntfy
3
- Version: 0.5.1
3
+ Version: 0.5.2
4
4
  Summary: An ntfy library aiming for feature completeness
5
5
  License: MIT
6
6
  Author: Matthew Cane
@@ -67,35 +67,26 @@ See the full documentation at [https://matthewcane.github.io/python-ntfy/](https
67
67
  - [Email notifications](https://docs.ntfy.sh/publish/#e-mail-notifications)
68
68
  - Send to multiple topics at once
69
69
 
70
- ## Testing and Development
70
+ ## Contributing
71
71
 
72
72
  This project uses:
73
73
 
74
74
  - [Poetry](https://python-poetry.org/) as it's dependency manager
75
- - [Ruff](https://docs.astral.sh/ruff/) for linting and code formatting
76
- - [MyPy](https://mypy-lang.org/) for static type checking
77
- - [Pre-Commit](https://pre-commit.com/) for running the above tools before committing
75
+ - [Just](https://github.com/casey/just) as a task runner
76
+ - [Pre-commit](https://pre-commit.com/) for running checks before each commit
77
+ - [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) for running tests
78
78
 
79
- To install dev dependencies, run `poetry install --with dev`.
79
+ These need to be installed separately to run the tasks.
80
80
 
81
- To install pre-commit hooks, run `pre-commit install`.
81
+ To see all available tasks, run `just`.
82
82
 
83
- ### Linting, Formatting and Type Checking
83
+ Some useful tasks are:
84
84
 
85
- These can be run with:
86
-
87
- - `poetry run ruff format`
88
- - `poetry run ruff check`
89
- - `poetry run mypy .`
90
-
91
- These tools are also run in the CI pipeline and must pass before merging.
85
+ - `just install` - Install dependencies (including dev dependencies)
86
+ - `just test` - Run all tests and checks
87
+ - `just serve-docs` - Build and serve the docs locally
92
88
 
93
89
  ### Tests
94
90
 
95
91
  This project is aiming for 95% code coverage. Any added features must include comprehensive tests.
96
92
 
97
- #### Testing Steps
98
-
99
- 1. Make sure you have `docker` and `docker-compose` installed
100
- 2. Run the tests with `poetry run pytest --cov` or use the VSCode testing extension
101
-
@@ -48,34 +48,25 @@ See the full documentation at [https://matthewcane.github.io/python-ntfy/](https
48
48
  - [Email notifications](https://docs.ntfy.sh/publish/#e-mail-notifications)
49
49
  - Send to multiple topics at once
50
50
 
51
- ## Testing and Development
51
+ ## Contributing
52
52
 
53
53
  This project uses:
54
54
 
55
55
  - [Poetry](https://python-poetry.org/) as it's dependency manager
56
- - [Ruff](https://docs.astral.sh/ruff/) for linting and code formatting
57
- - [MyPy](https://mypy-lang.org/) for static type checking
58
- - [Pre-Commit](https://pre-commit.com/) for running the above tools before committing
56
+ - [Just](https://github.com/casey/just) as a task runner
57
+ - [Pre-commit](https://pre-commit.com/) for running checks before each commit
58
+ - [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) for running tests
59
59
 
60
- To install dev dependencies, run `poetry install --with dev`.
60
+ These need to be installed separately to run the tasks.
61
61
 
62
- To install pre-commit hooks, run `pre-commit install`.
62
+ To see all available tasks, run `just`.
63
63
 
64
- ### Linting, Formatting and Type Checking
64
+ Some useful tasks are:
65
65
 
66
- These can be run with:
67
-
68
- - `poetry run ruff format`
69
- - `poetry run ruff check`
70
- - `poetry run mypy .`
71
-
72
- These tools are also run in the CI pipeline and must pass before merging.
66
+ - `just install` - Install dependencies (including dev dependencies)
67
+ - `just test` - Run all tests and checks
68
+ - `just serve-docs` - Build and serve the docs locally
73
69
 
74
70
  ### Tests
75
71
 
76
72
  This project is aiming for 95% code coverage. Any added features must include comprehensive tests.
77
-
78
- #### Testing Steps
79
-
80
- 1. Make sure you have `docker` and `docker-compose` installed
81
- 2. Run the tests with `poetry run pytest --cov` or use the VSCode testing extension
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "python-ntfy"
3
- version = "0.5.1"
3
+ version = "0.5.2"
4
4
  description = "An ntfy library aiming for feature completeness"
5
5
  authors = ["Matthew Cane <matthew.cane0@gmail.com>"]
6
6
  readme = "README.md"
@@ -33,7 +33,6 @@ types-pygments = "^2.18.0.20240506"
33
33
  types-colorama = "^0.4.15.20240311"
34
34
  types-requests = "^2.32.0.20241016"
35
35
  types-setuptools = ">=75.2.0.20241018,<81.0.0.0"
36
- black = ">=24.10,<26.0"
37
36
 
38
37
  [build-system]
39
38
  requires = ["poetry-core"]
File without changes