view doc/libervia-cli/uri.rst @ 4081:84f6bee6440d

installation: moved from `setup.py` to `pyproject.toml`: - updated installation to use the now standard `pyproject.toml` instead of legacy `setup.py`. `setup.py` and other legacy files have been deleted. - removed outdated README4PACKAGERS - removed pylintrc which has not been correctly reviewed. Linter conf should go to `pyproject.toml` now. - [hatch](https://hatch.pypa.io) is now used as main building tool. However, thanks to the use of standards, other tools can be used too. - update .hgignore - several dependencies version bump, with code update to adapt to changes.
author Goffi <goffi@goffi.org>
date Tue, 06 Jun 2023 16:45:16 +0200
parents c80a0f864b5d
children
line wrap: on
line source

================================
uri: XMPP URI parsing/generation
================================

URI commands are helper to easily parse/build XMPP URIs.

parse
=====

Parse an XMPP URI, and print different parts.

When possible, the ``type`` of URI is shown (e.g. ``pubsub``) and the ``sub_type`` (e.g.
``microblog``).

The ``path`` is always displayed (see `RFC 5122 Path section`_ for details).

If suitable, you'll also get data like ``node`` (for a PubSub URI).

.. _RFC 5122 Path section: https://tools.ietf.org/html/rfc5122#section-2.4

examples
--------

Parse a blog URI::

  $ li uri parse "xmpp:somebody@example.org?;node=urn%3Axmpp%3Amicroblog%3A0"

build
======

Build an XMPP URI according to arguments. 2 positional arguments are expected: ``type``
and ``path``. For now, only ``pubsub`` type is supported.

examples
--------

Build XMPP URI for a blog::

  $ li uri build pubsub somebody@example.org -f node urn:xmpp:microblog:0