Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: create a venv to pip install pylxd #597

Merged
merged 4 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,16 @@ A Python library for interacting with the LXD REST API.

Installation
=============
``pip install pylxd``
.. 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
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/source/clustering.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ the `LXD Cluster REST API`_ documentation.
.. links

.. _LXD Clustering: https://documentation.ubuntu.com/lxd/en/latest/clustering/
.. _LXD REST API: https://documentation.ubuntu.com/lxd/en/latest/api/
.. _LXD Cluster REST API: https://documentation.ubuntu.com/lxd/en/latest/api/#/cluster
5 changes: 2 additions & 3 deletions doc/source/storage-pools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,7 @@ The following methods are accessed from the `snapshots` attribute on the `Storag

- `all` - Get all the snapshots from the storage volume.
- `get` - Get a single snapshot using its name.
- `create` - Take a snapshot on the current stage of the storage volume. The new snapshot's
name and expiration date can be set, default name is in the format "snapX".
- `create` - Take a snapshot on the current stage of the storage volume. The new snapshot's name and expiration date can be set, default name is in the format "snapX".
- `exists` - Returns True if a storage volume snapshot with the given name exists, returns False otherwise.

Methods available on the storage snapshot object
Expand All @@ -185,4 +184,4 @@ the following methods are available:
.. links

.. _LXD Storage Pools: https://documentation.ubuntu.com/lxd/en/latest/storage/
.. _LXD REST API: https://documentation.ubuntu.com/lxd/en/latest/api/
simondeziel marked this conversation as resolved.
Show resolved Hide resolved
.. _LXD Storage Pools REST API: https://documentation.ubuntu.com/lxd/en/latest/api/#/storage