Metadata-Version: 2.1
Name: aioxmlrpc
Version: 0.10.0
Summary: XML-RPC client for asyncio
Author-Email: Guillaume Gauvrit <guillaume@gauvr.it>
License: MIT License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Networking
Classifier: Typing :: Typed
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
Project-URL: Homepage, https://github.com/mardiros/aioxmlrpc
Project-URL: Documentation, https://github.com/mardiros/aioxmlrpc/blob/main/README.rst
Project-URL: Repository, https://github.com/mardiros/aioxmlrpc.git
Project-URL: Issues, https://github.com/mardiros/aioxmlrpc/issues
Project-URL: Changelog, https://mardiros.github.io/aioxmlrpc/user/changelog.html
Requires-Python: >=3.9
Requires-Dist: httpx<1,>=0.24
Provides-Extra: server
Requires-Dist: starlette>=0.46.2; extra == "server"
Requires-Dist: uvicorn>=0.34.1; extra == "server"
Description-Content-Type: text/x-rst

=========
aioxmlrpc
=========

.. image:: https://github.com/mardiros/aioxmlrpc/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/mardiros/aioxmlrpc/actions/workflows/tests.yml


.. image:: https://codecov.io/gh/mardiros/aioxmlrpc/branch/master/graph/badge.svg?token=BR3KttC9uJ
   :target: https://codecov.io/gh/mardiros/aioxmlrpc


Asyncio version of the standard lib ``xmlrpc``

``aioxmlrpc.client``, which works like ``xmlrpc.client`` but uses coroutines,
has been implemented.

``aioxmlrpc.client`` is based on ``httpx`` for the transport, and just patch
the necessary from the python standard library to get it working.


``aioxmlrpc.server``, which works much like ``xmlrpc.server``, but runs on the asyncio
event loop and handles remote procedure calls (RPC) using both regular functions and coroutines.


``aioxmlrpc.server`` is based on ``starlette`` and ``uvicorn`` for handling HTTP.


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

aioxmlrpc is available on PyPI, it can simply be installed with your favorite
tool, example with pip here.

::

    pip install aioxmlrpc


The server dependencies is installed using the extra syntax.

::

   pip install "aioxmlrpc[server]"


Getting Started
---------------

Client
~~~~~~

This example show how to print the current version of the Gandi XML-RPC api.


::

    import asyncio
    from aioxmlrpc.client import ServerProxy


    async def print_gandi_api_version():
        api = ServerProxy('https://rpc.gandi.net/xmlrpc/')
        result = await api.version.info()
        print(result)

    if __name__ == '__main__':
        loop = asyncio.get_event_loop()
        loop.run_until_complete(print_gandi_api_version())
        loop.stop()


Run the example

::

    uv run examples/gandi_api_version.py


Server
~~~~~~

This example show an exemple of the server side.


::

   import asyncio
   from aioxmlrpc.server import SimpleXMLRPCServer


   class Api:
      def info(self):
         return "1.0.0"

      async def sleep(self):
         await asyncio.sleep(1)
         return "done"


   async def main():
      server = SimpleXMLRPCServer(("0.0.0.0", 8080))
      server.register_instance(Api(), allow_dotted_names=True)
      await server.serve_forever()


   if __name__ == "__main__":
      asyncio.run(main())