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.

Sign up for GitHub

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

Update installation instructions to use poetry #1259

Merged
merged 2 commits into from
Dec 15, 2021
Merged

Update installation instructions to use poetry #1259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5259be
Update installation instructions to use poetry
rytilahti Dec 15, 2021
9912679
Remove non-accessible modules from api toc
rytilahti Dec 15, 2021
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
8 changes: 1 addition & 7 deletions docs/api/miio.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Subpackages
:maxdepth: 4

miio.gateway
miio.integrations

Submodules
----------
Expand Down Expand Up @@ -44,7 +45,6 @@ Submodules
miio.device
miio.deviceinfo
miio.discovery
miio.dreamevacuum_miot
miio.exceptions
miio.extract_tokens
miio.fan
Expand All @@ -63,22 +63,16 @@ Submodules
miio.powerstrip
miio.protocol
miio.pwzn_relay
miio.roidmivacuum_miot
miio.scishare_coffeemaker
miio.toiletlid
miio.updater
miio.utils
miio.vacuum
miio.vacuum_cli
miio.vacuum_tui
miio.vacuumcontainers
miio.viomivacuum
miio.walkingpad
miio.waterpurifier
miio.waterpurifier_yunmi
miio.wifirepeater
miio.wifispeaker
miio.yeelight
miio.yeelight_dual_switch

Module contents
Expand Down
38 changes: 30 additions & 8 deletions docs/discovery.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,40 @@ Getting started
Installation
============

The easiest way to install the package is to use pip:
``pip3 install python-miio`` . `Using
virtualenv <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`__
is recommended.
You can install the most recent release using pip:

.. code-block:: console

Please make sure you have ``libffi`` and ``openssl`` headers installed, you can
do this on Debian-based systems (like Rasperry Pi) with
pip install python-miio

.. code-block:: bash

apt-get install libffi-dev libssl-dev
Alternatively, you can clone this repository and use poetry to install the current master:

.. code-block:: console

git clone https://github.com/rytilahti/python-miio.git
cd python-miio/
poetry install

This will install python-miio into a separate virtual environment outside of your regular python installation.
You can then execute installed programs (like ``miiocli``):

.. code-block:: console

poetry run miiocli --help

.. tip::

If you want to execute more commands in a row, you can activate the
created virtual environment to avoid typing ``poetry run`` for each
invocation:

.. code-block:: console

poetry shell
miiocli --help
miiocli discover


Device discovery
================
Expand Down
Loading