aioipp 0.18.0__tar.gz

aioipp-0.18.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Chris Talkington
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aioipp-0.18.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: aioipp
+Version: 0.18.0
+Summary: Asynchronous Python client for Internet Printing Protocol (IPP), a maintained fork of pyipp
+License: MIT
+License-File: LICENSE
+Keywords: ipp,api,async,client,printer
+Author: Chris Talkington
+Author-email: chris@talkingtontech.com
+Maintainer: Brian Egge
+Maintainer-email: brianegge@gmail.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: aiohttp (>=3.0.0)
+Requires-Dist: async-timeout (==5.0.1) ; python_version < "3.11"
+Requires-Dist: awesomeversion (>=21.10.1)
+Requires-Dist: backoff (>=2.2.0)
+Requires-Dist: deepmerge (>=1.1.0)
+Requires-Dist: yarl (>=1.6.0)
+Project-URL: Bug Tracker, https://github.com/brianegge/aioipp/issues
+Project-URL: Changelog, https://github.com/brianegge/aioipp/releases
+Project-URL: Documentation, https://github.com/brianegge/aioipp
+Project-URL: Homepage, https://github.com/brianegge/aioipp
+Project-URL: Repository, https://github.com/brianegge/aioipp
+Description-Content-Type: text/markdown
+
+# Python: Internet Printing Protocol (IPP) Client
+
+Asynchronous Python client for Internet Printing Protocol (IPP).
+
+> **Note:** `aioipp` is a maintained fork of [pyipp](https://github.com/ctalkington/python-ipp)
+> by Chris Talkington. It keeps the `pyipp` import name and adds page counter support.
+> It is published on PyPI as `aioipp`; do not install it alongside `pyipp`.
+
+## About
+
+This package allows you to monitor printers that support the Internet Printing Protocol (IPP) programmatically.
+
+## Installation
+
+```bash
+pip install aioipp
+```
+
+## Usage
+
+```python
+import asyncio
+
+from pyipp import IPP, Printer
+
+
+async def main():
+    """Show example of connecting to your IPP print server."""
+    async with IPP("ipps://EPSON123456.local:631/ipp/print") as ipp:
+        printer: Printer = await ipp.printer()
+        print(printer)
+
+
+if __name__ == "__main__":
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(main())
+```
+
+## Setting up development environment
+
+This Python project is fully managed using the [Poetry](https://python-poetry.org) dependency
+manager. But also relies on the use of NodeJS for certain checks during
+development.
+
+You need at least:
+
+- Python 3.9+
+- [Poetry](https://python-poetry.org/docs/#installation)
+- NodeJS 20+ (including NPM)
+
+To install all packages, including all development requirements:
+
+```bash
+npm install
+poetry install
+```
+
+As this repository uses the [pre-commit](https://pre-commit.com/) framework, all changes
+are linted and tested with each commit. You can run all checks and tests
+manually, using the following command:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+To run just the Python tests:
+
+```bash
+poetry run pytest
+```
+

aioipp-0.18.0/README.md

@@ -0,0 +1,70 @@
+# Python: Internet Printing Protocol (IPP) Client
+
+Asynchronous Python client for Internet Printing Protocol (IPP).
+
+> **Note:** `aioipp` is a maintained fork of [pyipp](https://github.com/ctalkington/python-ipp)
+> by Chris Talkington. It keeps the `pyipp` import name and adds page counter support.
+> It is published on PyPI as `aioipp`; do not install it alongside `pyipp`.
+
+## About
+
+This package allows you to monitor printers that support the Internet Printing Protocol (IPP) programmatically.
+
+## Installation
+
+```bash
+pip install aioipp
+```
+
+## Usage
+
+```python
+import asyncio
+
+from pyipp import IPP, Printer
+
+
+async def main():
+    """Show example of connecting to your IPP print server."""
+    async with IPP("ipps://EPSON123456.local:631/ipp/print") as ipp:
+        printer: Printer = await ipp.printer()
+        print(printer)
+
+
+if __name__ == "__main__":
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(main())
+```
+
+## Setting up development environment
+
+This Python project is fully managed using the [Poetry](https://python-poetry.org) dependency
+manager. But also relies on the use of NodeJS for certain checks during
+development.
+
+You need at least:
+
+- Python 3.9+
+- [Poetry](https://python-poetry.org/docs/#installation)
+- NodeJS 20+ (including NPM)
+
+To install all packages, including all development requirements:
+
+```bash
+npm install
+poetry install
+```
+
+As this repository uses the [pre-commit](https://pre-commit.com/) framework, all changes
+are linted and tested with each commit. You can run all checks and tests
+manually, using the following command:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+To run just the Python tests:
+
+```bash
+poetry run pytest
+```

aioipp-0.18.0/pyproject.toml

@@ -0,0 +1,178 @@
+[tool.poetry]
+name = "aioipp"
+description = "Asynchronous Python client for Internet Printing Protocol (IPP), a maintained fork of pyipp"
+authors = ["Chris Talkington <chris@talkingtontech.com>"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Framework :: AsyncIO",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+keywords = ["ipp", "api", "async", "client", "printer"]
+documentation = "https://github.com/brianegge/aioipp"
+homepage = "https://github.com/brianegge/aioipp"
+license = "MIT"
+maintainers = ["Brian Egge <brianegge@gmail.com>"]
+packages = [
+  {include = "pyipp", from = "src"},
+]
+readme = "README.md"
+repository = "https://github.com/brianegge/aioipp"
+version = "0.18.0"
+
+[tool.poetry.dependencies]
+aiohttp = ">=3.0.0"
+async-timeout = { version = "5.0.1", python = "<3.11" }
+awesomeversion = ">=21.10.1"
+backoff = ">=2.2.0"
+deepmerge = ">=1.1.0"
+python = "^3.9"
+yarl = ">=1.6.0"
+
+[tool.poetry.dev-dependencies]
+aresponses = "3.0.0"
+black = "25.1.0"
+blacken-docs = "1.19.1"
+codespell = "2.4.1"
+covdefaults = "2.3.0"
+coverage = {version = "7.9.1", extras = ["toml"]}
+mypy = "1.16.0"
+pre-commit = "4.2.0"
+pre-commit-hooks = "5.0.0"
+pylint = "3.3.7"
+pytest = "8.4.0"
+pytest-asyncio = "1.0.0"
+pytest-cov = "6.2.1"
+ruff = "0.6.9"
+safety = "3.5.2"
+syrupy = "4.9.1"
+types-cachetools = "^5.3.0"
+yamllint = "1.37.1"
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/brianegge/aioipp/issues"
+Changelog = "https://github.com/brianegge/aioipp/releases"
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 53
+
+[tool.coverage.run]
+plugins = ["covdefaults"]
+source = ["pyipp"]
+
+[tool.mypy]
+# Specify the target platform details in config, so your developers are
+# free to run mypy on Windows, Linux, or macOS and get consistent
+# results.
+platform = "linux"
+python_version = 3.9
+
+# show error messages from unrelated files
+follow_imports = "normal"
+
+# suppress errors about unsatisfied imports
+ignore_missing_imports = true
+
+# be strict
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+no_implicit_reexport = true
+strict_optional = true
+warn_incomplete_stub = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+[[tool.mypy.overrides]]
+follow_imports = "skip"
+module = "mypy-aiohttp.*"
+
+[tool.pylint.MASTER]
+extension-pkg-whitelist = [
+  "pydantic",
+]
+ignore = [
+  "examples",
+  "tests",
+]
+
+[tool.pylint.BASIC]
+good-names = [
+  "_",
+  "ex",
+  "fp",
+  "i",
+  "id",
+  "j",
+  "k",
+  "on",
+  "Run",
+  "T",
+  "wv",
+]
+
+[tool.pylint."MESSAGES CONTROL"]
+disable = [
+  "too-few-public-methods",
+  "too-many-arguments",
+  "duplicate-code",
+  "format",
+  "unsubscriptable-object",
+]
+
+[tool.pylint.SIMILARITIES]
+ignore-imports = true
+
+[tool.pylint.FORMAT]
+max-line-length = 88
+
+[tool.pylint.DESIGN]
+max-attributes = 20
+
+[tool.pyright]
+include = ["src"]
+
+[tool.pytest.ini_options]
+addopts = "--cov"
+asyncio_mode = "auto"
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+  "ANN101", # Self... explanatory
+  "ANN401", # Opinionated warning on disallowing dynamically typed expressions
+  "D203", # Conflicts with other rules
+  "D213", # Conflicts with other rules
+  "D417", # False positives in some occasions
+  "PLR2004", # Just annoying, not really useful
+  "TRY003",
+  "EM101",
+  "EXE002",
+]
+
+[tool.ruff.lint.flake8-pytest-style]
+mark-parentheses = false
+fixture-parentheses = false
+
+[tool.ruff.lint.isort]
+known-first-party = ["pyipp"]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 25
+
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core>=1.0.0"]

aioipp-0.18.0/src/pyipp/__init__.py

@@ -0,0 +1,34 @@
+"""Asynchronous Python client for IPP."""
+from .exceptions import (
+    IPPConnectionError,
+    IPPConnectionUpgradeRequired,
+    IPPError,
+    IPPParseError,
+    IPPResponseError,
+    IPPVersionNotSupportedError,
+)
+from .ipp import IPP
+from .models import (
+    Counters,
+    Info,
+    Marker,
+    Printer,
+    State,
+    Uri,
+)
+
+__all__ = [
+    "Counters",
+    "Info",
+    "Marker",
+    "Printer",
+    "State",
+    "Uri",
+    "IPP",
+    "IPPConnectionError",
+    "IPPConnectionUpgradeRequired",
+    "IPPError",
+    "IPPParseError",
+    "IPPResponseError",
+    "IPPVersionNotSupportedError",
+]

aioipp-0.18.0/src/pyipp/const.py

@@ -0,0 +1,52 @@
+"""Constants for IPP."""
+
+DEFAULT_CHARSET = "utf-8"
+DEFAULT_CHARSET_LANGUAGE = "en-US"
+
+DEFAULT_CLASS_ATTRIBUTES = ["printer-name", "member-names"]
+
+DEFAULT_JOB_ATTRIBUTES = [
+    "job-id",
+    "job-name",
+    "printer-uri",
+    "job-state",
+    "job-state-reasons",
+    "job-hold-until",
+    "job-media-progress",
+    "job-k-octets",
+    "number-of-documents",
+    "copies",
+    "job-originating-user-name",
+]
+
+DEFAULT_PRINTER_ATTRIBUTES = [
+    "printer-device-id",
+    "printer-name",
+    "printer-type",
+    "printer-location",
+    "printer-info",
+    "printer-make-and-model",
+    "printer-state",
+    "printer-state-message",
+    "printer-state-reasons",
+    "printer-supply",
+    "printer-up-time",
+    "printer-uri-supported",
+    "device-uri",
+    "printer-is-shared",
+    "printer-more-info",
+    "printer-firmware-string-version",
+    "marker-colors",
+    "marker-high-levels",
+    "marker-levels",
+    "marker-low-levels",
+    "marker-names",
+    "marker-types",
+    "printer-impressions-completed",
+    "printer-impressions-completed-col",
+    "printer-pages-completed",
+    "printer-media-sheets-completed",
+]
+
+DEFAULT_PORT = 631
+DEFAULT_PROTO_VERSION = (2, 0)