Tidy readme

README.md

@@ -5,27 +5,26 @@
 [![Sponsor](https://img.shields.io/badge/sponsor-%F0%9F%92%96-green)](https://github.com/sponsors/robmarkcole)
 
 ## Introduction
-The `HASS-data-detective` package provides classes and functions to help you explore and analyse the data in your Home Assistant database. If you are using [Hassio](https://www.home-assistant.io/hassio/), it will automatically discover your database and by default collect information about the entities in your database. [Usage of detective.ipynb](https://github.com/robmarkcole/HASS-data-detective/tree/master/usage) shows examples of using the package.
+The `HASS-data-detective` package provides classes and functions to help you explore and analyse the data in your Home Assistant database. If you are using [Hassio](https://www.home-assistant.io/hassio/), it will automatically discover your database and by default collect information about the entities in your database. See the notebooks directory for examples of using the detective package.
+
+## Installation on your machine
+You can either: `pip install HASS-data-detective` for the latest released version from pypi, or `pip install git+https://github.com/robmarkcole/HASS-data-detective.git --upgrade` for the bleeding edge version from github. Note that due to the matplotlib dependency, libfreetype6-dev is a requirement on `aarch64` platforms (i.e. RPi).
 
 ## Run with Docker locally
-You can use the detective package within a Docker container o there is no need to install anything on your machine. Note this will pull the [jupyter/scipy-notebook](https://github.com/jupyter/docker-stacks/blob/master/scipy-notebook/Dockerfile) image the first time you run it, but subsequent runs will be much faster.
+You can use the detective package within a Docker container so there is no need to install anything on your machine (assuming you already have docker installed). Note this will pull the [jupyter/scipy-notebook](https://github.com/jupyter/docker-stacks/blob/master/scipy-notebook/Dockerfile) docker image the first time you run it, but subsequent runs will be much faster.
 
-Run:
+From the root directory of this repo run:
 ```
 docker run --rm -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes -v "$PWD":/home/jovyan/work jupyter/scipy-notebook
 ```
 Follow the URL printed to the terminal, which opens a Jupyter lab instance. Open a new terminal in Jupyter lab and navigate to the `work` directory containing `setup.py`, then run:
  ```
  ~/work$ pip install .
  ```
-You can now navigate to the notebooks directory and start using the detective package.
+You can now navigate to the notebooks directory and start using the detective package. Note that you can install any package you want from pypi, but they will not persist on restarting the container.
 
 ## Try out detective online
-You can try out detective online without installing anything. If you click on the 'launch binder' button above, detective will be started in a Docker container online using the [Binderhub](https://binderhub.readthedocs.io) service. Run the `Usage of detective` notebook to explore detective, and you can also use the `Upload` button to upload your own `home-assistant_v2.db` database file for analysis. Note that all data is deleted when the container closes down, so this service is just for trying out detective.
-
-## Installation on you machine
-You can either: `pip install HASS-data-detective` for the latest released version from pypi, or `pip install git+https://github.com/robmarkcole/HASS-data-detective.git --upgrade` for the bleeding edge version from github. Alternatively if you wish to contribute to the development of detective, clone this repository and install in editable mode with `pip install -e .`
-Note that the HASS-data-detective pulls in 'matplotlib'  as dependency and that in turn will require 'libfreetype6-dev' to be present on systems with `aarch64` to build successfully.
+You can try out the latest version of detective from pypi without installing anything. If you click on the 'launch binder' button above, detective will be started in a Docker container online using the [Binderhub](https://binderhub.readthedocs.io) service. Run the `Usage of detective` notebook to explore detective, and you can also use the `Upload` button to upload your own `home-assistant_v2.db` database file for analysis. Note that all data is deleted when the container closes down, so this service is just for trying out detective.
 
 ### Auth helpers
 When querying the database, you might end up with user IDs and refresh token IDs. We've included a helper to help load the auth from Home Assistant and help you process this data.
@@ -70,4 +69,4 @@ Big thanks to [@balloob](https://github.com/balloob) and [@frenck](https://githu
 
 https://github.com/sponsors/robmarkcole
 
-If you or your business find this work useful please consider becoming a sponsor at the link above, this really helps justify the time I invest in maintaining this repo. As we say in England, 'every little helps' - thanks in advance! 
+If you or your business find this work useful please consider becoming a sponsor at the link above, this really helps justify the time I invest in maintaining this repo. As we say in England, 'every little helps' - thanks in advance!

setup.py

@@ -1,32 +1,35 @@
 from setuptools import setup, find_packages
 
-with open('requirements.txt') as f:
+with open("requirements.txt") as f:
     REQUIRED = f.read().splitlines()
 
-PROJECT_DESCRIPTION = ('Tools for studying Home-Assistant data.')
-PROJECT_LONG_DESCRIPTION = ('Home Assistant is an open-source '
-                            'home automation platform running on Python 3. '
-                            'This package provides a set of convenience '
-                            'functions and classes to analyse the data '
-                            'in your Home-Assistant database. ')
+PROJECT_DESCRIPTION = "Tools for studying Home-Assistant data."
+PROJECT_LONG_DESCRIPTION = (
+    "Home Assistant is an open-source "
+    "home automation platform running on Python 3. "
+    "This package provides a set of convenience "
+    "functions and classes to analyse the data "
+    "in your Home-Assistant database. "
+)
 
 setup(
-    name='HASS-data-detective',
-    version='1.0',
-    packages=find_packages(exclude=('tests',)),
-    url='https://github.com/robmarkcole/HASS-data-detective',
-    keywords=['home', 'automation'],
-    author='Robin Cole',
-    author_email='[email protected]',
+    name="HASS-data-detective",
+    version="2.0",
+    packages=find_packages(exclude=("tests",)),
+    url="https://github.com/robmarkcole/HASS-data-detective",
+    keywords=["home", "automation"],
+    author="Robin Cole",
+    author_email="[email protected]",
     description=PROJECT_DESCRIPTION,
     long_description=PROJECT_LONG_DESCRIPTION,
     install_requires=REQUIRED,
-    license='MIT',
+    license="MIT",
     classifiers=[
         "Development Status :: 4 - Beta",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: MIT License",
         "Natural Language :: English",
         "Programming Language :: Python",
-        "Programming Language :: Python :: 3"]
+        "Programming Language :: Python :: 3",
+    ],
 )