Skip to content

Commit

Permalink
rename package to watttime, with pypi publisher
Browse files Browse the repository at this point in the history
  • Loading branch information
sam-watttime committed Dec 22, 2023
1 parent c6a5d31 commit 3b49b7f
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/p/watttime-client/
url: https://pypi.org/p/watttime/
permissions:
id-token: write # IMPORTANT: mandatory for trusted publishing

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ wt_myaccess = WattTimeMyAccess()
Users may first want to query the `/v3/my-access` endpoint using the `WattTimeMyAccess` class to get a dataframe of regions and signal types available to them:

```python
from watttime_client import WattTimeMyAccess
from watttime import WattTimeMyAccess

wt_myaccess = WattTimeMyAccess(username, password)

Expand All @@ -43,7 +43,7 @@ wt_myaccess.get_access_pandas()
Once you confirm your access, you may wish to request data for a particular balancing authority:

```python
from watttime_client import WattTimeHistorical
from watttime import WattTimeHistorical

wt_hist = WattTimeHistorical(username, password)

Expand All @@ -67,7 +67,7 @@ wt_hist.get_historical_csv(
You could also combine these classes to iterate through all regions where you have access to data:

```python
from watttime_client import WattTimeMyAccess, WattTimeHistorical
from watttime import WattTimeMyAccess, WattTimeHistorical
import pandas as pd

wt_myaccess = WattTimeMyAccess(username, password)
Expand All @@ -90,7 +90,7 @@ for region in moer_regions:
You can also use the SDK to request a current forecast for some signal types, such as co2_moer and health_damage:

```python
from watttime_client import WattTimeForecast
from watttime import WattTimeForecast

wt_forecast = WattTimeForecast(username, password)
forecast = wt_forecast.get_forecast_json(
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
from setuptools import setup

setup(
name="watttime_client",
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.""",
long_description=open('README.md').read(),
long_description_content_type="text/markdown",
version="v1.0",
packages=["watttime_client"],
packages=["watttime"],
python_requires=">=3.8",
install_requires=["requests", "pandas>1.0.0", "python-dateutil"],
)
2 changes: 1 addition & 1 deletion tests/test_sdk.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from datetime import datetime, timedelta
from dateutil.parser import parse
from pytz import timezone, UTC
from watttime_client import (
from watttime import (
WattTimeBase,
WattTimeHistorical,
WattTimeMyAccess,
Expand Down
1 change: 1 addition & 0 deletions watttime/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from watttime.api import *
File renamed without changes.
1 change: 0 additions & 1 deletion watttime_client/__init__.py

This file was deleted.

0 comments on commit 3b49b7f

Please sign in to comment.