Skip to content

Commit

Permalink
Add pip install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ninadicara committed Apr 20, 2021
1 parent 134986f commit 2b7b29a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ This requires the files named ``StreamingHistory{n}.json`` where ``{n}`` represe

Quick start
==============
Extended documentation is `available on ReadTheDocs <https://spotify-rehydrator.readthedocs.io>`_. An example of using the package to rehydrate a folder of json files is::
Extended documentation is `available on ReadTheDocs <https://spotify-rehydrator.readthedocs.io>`_.
First, `install the package using pip. <https://pypi.org/project/spotifyrehydrator/>`_ An example of using the package to rehydrate a folder of json files is then::
# main.py
from spotifyrehydrator import Rehydrator
Expand Down
4 changes: 4 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ an output folder and a Client ID and Client Secret from the Spotify Developer Po
You will need to 'create an app' which have credentials associated with it.
Your app dashboard will give you access to your ``Client ID`` and a ``Client Secret``.

Install the *Spotify Rehydrator* using ``pip``::
pip install spotifyrehydrator


Assuming you have set your Client ID and Client Secret as environment variables then this is an example of how you could run the Rehydrator::
import os
Expand Down

0 comments on commit 2b7b29a

Please sign in to comment.