File: README.rst

package info (click to toggle)
aiohttp-asyncmdnsresolver 0.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 364 kB
  • sloc: python: 778; makefile: 229; sh: 5
file content (88 lines) | stat: -rw-r--r-- 2,861 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
aiohttp-asyncmdnsresolver
=========================

.. image:: https://github.com/aio-libs/aiohttp-asyncmdnsresolver/actions/workflows/ci-cd.yml/badge.svg
  :target: https://github.com/aio-libs/aiohttp-asyncmdnsresolver/actions?query=workflow%3ACI
  :align: right

.. image:: https://codecov.io/gh/aio-libs/aiohttp-asyncmdnsresolver/branch/main/graph/badge.svg
  :target: https://codecov.io/gh/aio-libs/aiohttp-asyncmdnsresolver

.. image:: https://badge.fury.io/py/aiohttp-asyncmdnsresolver.svg
    :target: https://badge.fury.io/py/aiohttp-asyncmdnsresolver


.. image:: https://readthedocs.org/projects/aiohttp-asyncmdnsresolver/badge/?version=latest
    :target: https://aiohttp-asyncmdnsresolver.readthedocs.io


.. image:: https://img.shields.io/pypi/pyversions/aiohttp-asyncmdnsresolver.svg
    :target: https://pypi.org/p/aiohttp-asyncmdnsresolver

.. image:: https://img.shields.io/matrix/aio-libs:matrix.org?label=Discuss%20on%20Matrix%20at%20%23aio-libs%3Amatrix.org&logo=matrix&server_fqdn=matrix.org&style=flat
   :target: https://matrix.to/#/%23aio-libs:matrix.org
   :alt: Matrix Room — #aio-libs:matrix.org

.. image:: https://img.shields.io/matrix/aio-libs-space:matrix.org?label=Discuss%20on%20Matrix%20at%20%23aio-libs-space%3Amatrix.org&logo=matrix&server_fqdn=matrix.org&style=flat
   :target: https://matrix.to/#/%23aio-libs-space:matrix.org
   :alt: Matrix Space — #aio-libs-space:matrix.org

Introduction
------------

This module provides an ``aiohttp`` resolver that supports mDNS, which uses the ``zeroconf`` library
to resolve mDNS queries.

For full documentation please read https://aiohttp-asyncmdnsresolver.readthedocs.io.

Installation
------------

.. code-block:: console

   $ pip install aiohttp-asyncmdnsresolver


Quick start
-----------

.. code-block:: python

   import asyncio
   import aiohttp
   from aiohttp_asyncmdnsresolver.api import AsyncMDNSResolver

   async def main():
       resolver = AsyncMDNSResolver()
       connector = aiohttp.TCPConnector(resolver=resolver)
       async with aiohttp.ClientSession(connector=connector) as session:
           async with session.get('http://example.com') as response:
               print(response.status)
           async with session.get('http://xxx.local.') as response:
               print(response.status)

   asyncio.run(main())


API documentation
-----------------

The documentation is located at https://aiohttp-asyncmdnsresolver.readthedocs.io.

Source code
-----------

The project is hosted on GitHub_

Please file an issue on the `bug tracker
<https://github.com/aio-libs/aiohttp-asyncmdnsresolver/issues>`_ if you have found a bug
or have some suggestion in order to improve the library.


Authors and License
-------------------

It's *Apache 2* licensed and freely available.


.. _GitHub: https://github.com/aio-libs/aiohttp-asyncmdnsresolver