Skip to content

Commit

Permalink
include pip install instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
sam-watttime committed Dec 22, 2023
1 parent 3b49b7f commit 2b62e4a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ Users must first [register for access to the WattTime API here](https://watttime
Full documentation of WattTime's API, along with response samples and information about [available endpoints is also available](https://docs.watttime.org/).

# Configuration
The SDK can be installed as a python package, we recommend using an environment manager such as [miniconda](https://docs.conda.io/projects/miniconda/en/latest/) or [venv](https://docs.python.org/3/library/venv.html).
The SDK can be installed as a python package from the PyPi repository, we recommend using an environment manager such as [miniconda](https://docs.conda.io/projects/miniconda/en/latest/) or [venv](https://docs.python.org/3/library/venv.html).
```
git clone [email protected]:WattTime/watttime-python-client.git
pip install watttime-python-client/
pip install watttime
```

Once registered for the WattTime API, you may set your credentials as environment variables to avoid passing these during class initialization:
Expand Down
6 changes: 2 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@

setup(
name="watttime",
description="""
A python software development kit with basic examples for using the
WattTime API, including data that spans across the 30 day API request limit.""",
description="An officially maintained python client for WattTime's API providing access to electricity grid emissions data.",
long_description=open('README.md').read(),
long_description_content_type="text/markdown",
version="v1.0",
version="v1.1",
packages=["watttime"],
python_requires=">=3.8",
install_requires=["requests", "pandas>1.0.0", "python-dateutil"],
Expand Down

0 comments on commit 2b62e4a

Please sign in to comment.