docs: fix pip url and line length in quickstart

main
svalouch 4 years ago
parent 280651a9b2
commit 18a0c0191e

@ -10,9 +10,9 @@ From the repo
You can pull the code from the repository at URL using pip: You can pull the code from the repository at URL using pip:
.. code-block:: bash ::
pip install git+ssh://URL/python-simplezfs pip install git+https://github.com/svalouch/python-simplezfs#egg=simplezfs
Interfaces Interfaces
@ -22,17 +22,17 @@ For both ``zfs(8)`` and ``zpool(8)`` there exist two interfaces:
* **cli** calls the ``zfs`` and ``zpool`` binaries in subprocesses * **cli** calls the ``zfs`` and ``zpool`` binaries in subprocesses
* **native** uses ``libzfs_core`` to achieve the same goals * **native** uses ``libzfs_core`` to achieve the same goals
There exist two functions :func:`~simplezfs.zfs.get_zfs` and :func:`~simplezfs.zpool.get_zpool` that take the implementation as There exist two functions :func:`~simplezfs.zfs.get_zfs` and :func:`~simplezfs.zpool.get_zpool` that take the
first argument and return the appropriate implementation. The main documentation about how it works are in the api implementation as first argument and return the appropriate implementation. The main documentation about how it works
documentation for the interface classes :class:`~simplezfs.zfs.ZFS` and :class:`~simplezfs.zpool.ZPool`. are in the api documentation for the interface classes :class:`~simplezfs.zfs.ZFS` and :class:`~simplezfs.zpool.ZPool`.
This guide focuses on the ``cli`` variants. This guide focuses on the ``cli`` variants.
It is not strictly neccessary to get and pass around an instance every time, as the classes hold very little state. It is not strictly neccessary to get and pass around an instance every time, as the classes hold very little state.
They need to do some initialization however, such as finding the binaries (and thus hitting the local filesystem). They need to do some initialization however, such as finding the binaries (and thus hitting the local filesystem).
For the rest of the guide, we'll assume that the following has been run and we have a :class:`~simplezfs.zfs.ZFS` instance For the rest of the guide, we'll assume that the following has been run and we have a :class:`~simplezfs.zfs.ZFS`
in ``zfs``: instance in ``zfs``:
.. code-block:: pycon .. code-block:: pycon

Loading…
Cancel
Save