Metadata-Version: 2.1
Name: pylxd
Version: 2.3.5
Summary: python library for LXD
Home-page: https://ubuntu.com/lxd
Author: Paul Hummer and others (see CONTRIBUTORS.rst)
Author-email: lxd@lists.canonical.com
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: cryptography (>=3.2)
Requires-Dist: python-dateutil (>=2.4.2)
Requires-Dist: requests (>=2.20.0)
Requires-Dist: requests-toolbelt (>=0.8.0)
Requires-Dist: ws4py (!=0.3.5,>=0.3.4)
Provides-Extra: check
Requires-Dist: mypy ; extra == 'check'
Provides-Extra: doc
Requires-Dist: Sphinx ; extra == 'doc'
Provides-Extra: format
Requires-Dist: black (==23.1.0) ; extra == 'format'
Requires-Dist: flake8 (>=2.5.0) ; extra == 'format'
Requires-Dist: isort (==5.6.4) ; extra == 'format'
Provides-Extra: testing
Requires-Dist: ddt (>=0.7.0) ; extra == 'testing'
Requires-Dist: mock-services (>=0.3) ; extra == 'testing'
Requires-Dist: pytest-cov (==2.10.1) ; extra == 'testing'
Requires-Dist: pytest (>=6.1.2) ; extra == 'testing'
Requires-Dist: requests-mock (<1.2) ; extra == 'testing'
Requires-Dist: setuptools ; extra == 'testing'

pylxd
~~~~~

.. image:: http://img.shields.io/pypi/v/pylxd.svg
    :target: https://pypi.python.org/pypi/pylxd
.. image:: https://github.com/canonical/pylxd/workflows/CI%20tests/badge.svg
    :target: https://github.com/canonical/pylxd/actions?query=workflow%3A%22CI+tests%22
.. image:: https://codecov.io/github/canonical/pylxd/coverage.svg?branch=main
    :target: https://codecov.io/github/canonical/pylxd
.. image:: https://readthedocs.org/projects/pylxd/badge/?version=latest
    :target: https://pylxd.readthedocs.io/en/latest/?badge=latest

A Python library for interacting with the LXD REST API.

Installation
=============
.. code-block:: console

  # Create a virtual environment
  python3 -m venv myvenv
  cd myvenv

  # Activate the virtual environment
  . bin/activate
  # Install pyLXD in it
  pip install pylxd

Bug reports
===========

Bug reports can be filed on the `GitHub repository
<https://github.com/canonical/pylxd/issues/new>`_.

Support and discussions
=======================

We use the `LXD category on Ubuntu's Discourse
<https://discourse.ubuntu.com/c/lxd/126>`_.

If you prefer live discussions, some of us also hang out in
`#lxd
<https://web.libera.chat/#lxd>`_ on irc.libera.chat.

LXD Documentation: `https://documentation.ubuntu.com/lxd/en/latest/
<https://documentation.ubuntu.com/lxd/en/latest/>`_

PyLXD API Documentation: `https://pylxd.readthedocs.io/en/latest/
<https://pylxd.readthedocs.io/en/latest/>`_

Contributing to pyLXD
=====================

If you wish to contribute to pyLXD please read the `Contributing Guide
<https://pylxd.readthedocs.io/en/latest/contributing.html>`_, particularly
around unit tests, integration tests and signing commits.
