california-midasapi 0.0.2__tar.gz

california_midasapi-0.0.2/.github/workflows/python-publish.yml

@@ -0,0 +1,48 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  push:
+    branches: [ "main" ]
+    # Publish semver tags as releases.
+    tags: [ 'v*.*.*' ]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+    - name: Publish package to TestPyPI
+      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/

california_midasapi-0.0.2/.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+
+__test.py

california_midasapi-0.0.2/LICENSE.md

@@ -0,0 +1,11 @@
+
+
+MIT License
+
+Copyright (c) 2024 MattDahEpic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

california_midasapi-0.0.2/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: california-midasapi
+Version: 0.0.2
+Summary: Python wrapper for California's energy price API MIDAS.
+Author-email: MattDahEpic <matt+california-midasapipypi@mattdahepic.com>
+License: MIT
+Keywords: california,api,energy,midas,price
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: requests
+Requires-Dist: PyJWT
+Requires-Dist: python-dateutil
+
+# california-midasapi
+A Python wrapper for the California Energy Comission (CEC)'s Market Informed Demand Automation Server (MIDAS) energy price API.  
+This API lets you get info about energy prices in California from utilities regulated by the CEC, which is all the big ones (PG&E, SCE, SDG&E, SMUD, etc.) and some smaller municipal utilities. If you have a Rate Identification Number (RIN) QA Code on your electric bill you can use this API to get your electricity price in real time.
+
+
+## Usage
+1. Start by registering an account with MIDAS. There is no webpage for this so I have provided a helper. You only have to register an account once.
+```python
+from midas.authentication import Midas as Auth
+response = Auth.register("username", "password", "email@email.email", "Full Name")
+print(response)
+```
+You should see `User account for username was successfully created. A verification email has been sent to email@email.email. Please click the link in the email in order to start using the API.`.  
+Click the link in the email, then you can use the rest of the API as described below.
+
+2. Create a `Midas` object:
+```python
+from midas import Midas
+midas = Midas("username", "password")
+```
+
+3. Access the API methods using this object:
+```python
+# Get basic info about all rates
+from midas.ratelist import RINFilter
+rates = midas.GetAvailableRates(RINFilter.TARIFF)
+print(rates) # ~40k+ items at writing
+
+# Get specific info about one rate
+ratedata = midas.GetRateInfo('USCA-SMSM-AD00-0000')
+print(ratedata)
+# Get the currently applicable value from a rate (local filtering)
+print(ratedata.GetCurrentTariffs())
+```
+
+
+## Contributing
+Contributions are welcome, please submit a PR!
+
+
+## More Information & Thanks
+More info about MIDAS can be found at https://midasapi.energy.ca.gov/  
+Thank you to the CEC for providing example code at https://github.com/morganmshep/MIDAS-Python-Repository
+
+## Projects using this library
+
+
+If you have a project using this library, we'd love to hear about it! Let us know and we'll add it to this list.

california_midasapi-0.0.2/README.md

@@ -0,0 +1,48 @@
+# california-midasapi
+A Python wrapper for the California Energy Comission (CEC)'s Market Informed Demand Automation Server (MIDAS) energy price API.  
+This API lets you get info about energy prices in California from utilities regulated by the CEC, which is all the big ones (PG&E, SCE, SDG&E, SMUD, etc.) and some smaller municipal utilities. If you have a Rate Identification Number (RIN) QA Code on your electric bill you can use this API to get your electricity price in real time.
+
+
+## Usage
+1. Start by registering an account with MIDAS. There is no webpage for this so I have provided a helper. You only have to register an account once.
+```python
+from midas.authentication import Midas as Auth
+response = Auth.register("username", "password", "email@email.email", "Full Name")
+print(response)
+```
+You should see `User account for username was successfully created. A verification email has been sent to email@email.email. Please click the link in the email in order to start using the API.`.  
+Click the link in the email, then you can use the rest of the API as described below.
+
+2. Create a `Midas` object:
+```python
+from midas import Midas
+midas = Midas("username", "password")
+```
+
+3. Access the API methods using this object:
+```python
+# Get basic info about all rates
+from midas.ratelist import RINFilter
+rates = midas.GetAvailableRates(RINFilter.TARIFF)
+print(rates) # ~40k+ items at writing
+
+# Get specific info about one rate
+ratedata = midas.GetRateInfo('USCA-SMSM-AD00-0000')
+print(ratedata)
+# Get the currently applicable value from a rate (local filtering)
+print(ratedata.GetCurrentTariffs())
+```
+
+
+## Contributing
+Contributions are welcome, please submit a PR!
+
+
+## More Information & Thanks
+More info about MIDAS can be found at https://midasapi.energy.ca.gov/  
+Thank you to the CEC for providing example code at https://github.com/morganmshep/MIDAS-Python-Repository
+
+## Projects using this library
+
+
+If you have a project using this library, we'd love to hear about it! Let us know and we'll add it to this list.

california_midasapi-0.0.2/california_midasapi.egg-info/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: california-midasapi
+Version: 0.0.2
+Summary: Python wrapper for California's energy price API MIDAS.
+Author-email: MattDahEpic <matt+california-midasapipypi@mattdahepic.com>
+License: MIT
+Keywords: california,api,energy,midas,price
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: requests
+Requires-Dist: PyJWT
+Requires-Dist: python-dateutil
+
+# california-midasapi
+A Python wrapper for the California Energy Comission (CEC)'s Market Informed Demand Automation Server (MIDAS) energy price API.  
+This API lets you get info about energy prices in California from utilities regulated by the CEC, which is all the big ones (PG&E, SCE, SDG&E, SMUD, etc.) and some smaller municipal utilities. If you have a Rate Identification Number (RIN) QA Code on your electric bill you can use this API to get your electricity price in real time.
+
+
+## Usage
+1. Start by registering an account with MIDAS. There is no webpage for this so I have provided a helper. You only have to register an account once.
+```python
+from midas.authentication import Midas as Auth
+response = Auth.register("username", "password", "email@email.email", "Full Name")
+print(response)
+```
+You should see `User account for username was successfully created. A verification email has been sent to email@email.email. Please click the link in the email in order to start using the API.`.  
+Click the link in the email, then you can use the rest of the API as described below.
+
+2. Create a `Midas` object:
+```python
+from midas import Midas
+midas = Midas("username", "password")
+```
+
+3. Access the API methods using this object:
+```python
+# Get basic info about all rates
+from midas.ratelist import RINFilter
+rates = midas.GetAvailableRates(RINFilter.TARIFF)
+print(rates) # ~40k+ items at writing
+
+# Get specific info about one rate
+ratedata = midas.GetRateInfo('USCA-SMSM-AD00-0000')
+print(ratedata)
+# Get the currently applicable value from a rate (local filtering)
+print(ratedata.GetCurrentTariffs())
+```
+
+
+## Contributing
+Contributions are welcome, please submit a PR!
+
+
+## More Information & Thanks
+More info about MIDAS can be found at https://midasapi.energy.ca.gov/  
+Thank you to the CEC for providing example code at https://github.com/morganmshep/MIDAS-Python-Repository
+
+## Projects using this library
+
+
+If you have a project using this library, we'd love to hear about it! Let us know and we'll add it to this list.

california_midasapi-0.0.2/california_midasapi.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+.gitignore
+LICENSE.md
+README.md
+pyproject.toml
+.github/workflows/python-publish.yml
+california_midasapi.egg-info/PKG-INFO
+california_midasapi.egg-info/SOURCES.txt
+california_midasapi.egg-info/dependency_links.txt
+california_midasapi.egg-info/requires.txt
+california_midasapi.egg-info/top_level.txt
+midas/Midas.py
+midas/__init__.py
+midas/authentication.py
+midas/internal.py
+midas/ratelist.py
+midas/types.py

california_midasapi-0.0.2/california_midasapi.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

california_midasapi-0.0.2/california_midasapi.egg-info/requires.txt

@@ -0,0 +1,3 @@
+requests
+PyJWT
+python-dateutil

california_midasapi-0.0.2/california_midasapi.egg-info/top_level.txt

@@ -0,0 +1 @@
+midas

california_midasapi-0.0.2/midas/Midas.py

@@ -0,0 +1,9 @@
+from midas.authentication import Midas as MidasAuth
+from midas.ratelist import Midas as MidasRateList
+
+class Midas(MidasAuth, MidasRateList):
+    """
+    Python API for California's energy price database MIDAS.
+
+    Main class, imports most things from modules.
+    """

california_midasapi-0.0.2/midas/__init__.py

@@ -0,0 +1 @@
+from midas.Midas import Midas, MidasAuth, MidasRateList

california_midasapi-0.0.2/midas/authentication.py

@@ -0,0 +1,49 @@
+import requests
+import json
+import base64
+from midas.internal import Midas as Internal
+
+class Midas(Internal):
+    def __init__(self, username: str, password: str):
+        """
+        Create a new API wrapper instance using the given credentials.
+
+        Credentials are required, if you don't have an account use the static `register` method
+        """
+        self.username = username
+        self.password = password
+        self.auth_token: str = None
+    
+    @staticmethod
+    def register(username: str, password: str, email: str, fullname: str, organization: str = None) -> str:
+        """
+        Create a new account with the MIDAS server.
+
+        
+        """
+        username64 = str(base64.b64encode(username.encode("utf-8")), "utf-8")
+        password64 = str(base64.b64encode(password.encode("utf-8")), "utf-8")
+        email64 = str(base64.b64encode(email.encode("utf-8")), "utf-8")
+        fullname64 = str(base64.b64encode(fullname.encode("utf-8")), "utf-8")
+
+        registration_info = {
+            "username":username64,
+            "password":password64,
+            "emailaddress":email64,
+            "fullname":fullname64
+        }
+
+        if (organization is not None):
+            organization64 = str(base64.b64encode(organization.encode("utf-8")), "utf-8")
+            registration_info["organization"] = organization64
+
+        url = 'https://midasapi.energy.ca.gov/api/registration'
+        headers =  {"Content-Type":"application/json"}
+
+        response = requests.post(url, data=json.dumps(registration_info), headers=headers)
+
+        #Prints below will return 200 response for successful call
+        print(response)
+        #Response text should be: 'User account for your_user_name was successfully created. A verification email has been sent to your_email. Please click the link in the email in order to start using the API.'
+        print(response.text)
+

california_midasapi-0.0.2/midas/internal.py

@@ -0,0 +1,41 @@
+from typing import Literal
+import requests
+import base64
+import jwt
+import time
+
+class Midas():
+    def __request(self, method: Literal['GET', 'POST'], url: str):
+        """Preform a request with the stored auth token and return the body."""
+        if (self.auth_token is None or not Midas.__isTokenValid(self.auth_token)):
+            self.__loginAndStore(self.username, self.password)
+        headers = {
+            'Accept': 'application/json',
+            'User-Agent': 'california-midasapi.py',
+            'Authorization': "Bearer " + self.auth_token,
+        }
+        response = requests.request(method, url, headers=headers)
+        if (not response.ok):
+            raise f"Error preforming request: {response.status_code} {response.text}"
+        return response.text
+    
+    def __loginAndStore(self, username: str, password: str):
+        '''
+        Logs in with a username and password, storing the JWT token for use in future calls.
+        '''
+        credentials = username + ":" + password
+        credentials_encodedBytes = base64.b64encode(credentials.encode("utf-8"))
+    
+        headers = {b'Authorization': b'BASIC ' + credentials_encodedBytes}
+        url = 'https://midasapi.energy.ca.gov/api/token'
+
+        response = requests.get(url,headers=headers)
+
+        self.auth_token = response.headers['Token']
+    
+    @staticmethod
+    def __isTokenValid(token: str) -> bool:
+        """Return if the provided token is still valid"""
+        decoded = jwt.decode(token, algorithms=["HS256"], options={"verify_signature": False})
+        future = time.time() + 120 # 2 minutes from now
+        return decoded["exp"] > future # expires more than set time from now

california_midasapi-0.0.2/midas/ratelist.py

@@ -0,0 +1,46 @@
+from midas.internal import Midas as Internal
+from midas.types import RateListItem, ValueInfoItem, RateInfo
+from typing import Literal
+from enum import Enum
+import json
+
+class RINFilter(Enum):
+        """Filter options for the RIN list."""
+        ALL = 0
+        TARIFF = 1
+        GHG_EMISSION = 2
+        FLEX_ALERT = 3
+
+class Midas(Internal):
+
+    def GetAvailableRates(self, signaltype: RINFilter) -> 'list[RateListItem]':
+        """
+        Get all the available rates.
+        """
+
+        def __rateListItemHook(dict):
+             return RateListItem(**dict)
+
+        url = 'https://midasapi.energy.ca.gov/api/valuedata?signaltype=' + str(signaltype.value)
+        response = self.__request('GET', url)
+        return (json.loads(response, object_hook=__rateListItemHook))
+    
+    def GetRateInfo(self, rateID: str, queryType: Literal['alldata', 'realtime'] = 'alldata') -> RateInfo:
+        """
+        Returns data about a given a rate.
+        """
+
+        def __rateInfoObjectHook(dict):
+            # this has to handle both the parent object and its children
+            if "DateStart" in dict:
+                return ValueInfoItem(**dict)
+            elif "RateID" in dict:
+                return RateInfo(**dict)
+            else:
+                raise "Invalid object type for __rateInfoObjectHook"
+            
+        # TODO what does queryType=realtime even do? all properties are None
+        url = 'https://midasapi.energy.ca.gov/api/valuedata?id=' + rateID + '&querytype=' + queryType
+        pricing_response = self.__request('GET', url)
+
+        return (json.loads(pricing_response, object_hook=__rateInfoObjectHook))

california_midasapi-0.0.2/midas/types.py

@@ -0,0 +1,55 @@
+from dataclasses import dataclass, field
+from typing import Optional
+from datetime import datetime
+from dateutil import parser
+
+@dataclass
+class RateListItem():
+    RateID: str
+    SignalType: str
+    Description: str
+    LastUpdated: Optional[str] = None
+
+@dataclass
+class ValueInfoItem:
+    ValueName: str
+    DateStart: str
+    DateEnd: str
+    DayStart: str
+    DayEnd: str
+    TimeStart: str
+    TimeEnd: str
+    value: float
+    Unit: str
+
+    def GetStart(self) -> datetime:
+        """Get the start of this tariff as a python datetime"""
+        return parser.parse(f"{self.DateStart} {self.TimeStart} -07:00")
+
+
+    def GetEnd(self) -> datetime:
+        """Get the end of this tariff as a python datetime"""
+        return parser.parse(f"{self.DateEnd} {self.TimeEnd} -07:00")
+
+@dataclass
+class RateInfo:
+    RateID: str
+    SystemTime_UTC: str
+    RateName: str
+    RateType: str
+    Sector: str
+    API_Url: str
+    RatePlan_Url: str
+    EndUse: str
+    AltRateName1: str
+    AltRateName2: str
+    SignupCloseDate: str
+    ValueInformation: list[ValueInfoItem] = field(default_factory=list)
+    """The list of tariffs"""
+
+    def GetCurrentTariffs(self) -> list[ValueInfoItem]:
+        """Gets all tariffs that are currently active"""
+        
+        # ValueInformation where getstart < now < getend
+        now = datetime.now().timestamp()
+        return list(filter(lambda t: t.GetStart().timestamp() < now and t.GetEnd().timestamp() > now, self.ValueInformation))

california_midasapi-0.0.2/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools", "setuptools_scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "california-midasapi"
+dynamic = ["version"]
+description = "Python wrapper for California's energy price API MIDAS."
+readme = "README.md"
+authors = [
+    { name = "MattDahEpic", email = "matt+california-midasapipypi@mattdahepic.com" },
+]
+license = {text = "MIT"}
+keywords = ["california", "api", "energy", "midas", "price"]
+classifiers = [
+    'Development Status :: 3 - Alpha',
+    'Intended Audience :: Developers',
+    'Topic :: Scientific/Engineering',
+    'License :: OSI Approved :: MIT License',
+    'Programming Language :: Python :: 3',
+]
+dependencies = [
+    "requests",
+    "PyJWT",
+    "python-dateutil",
+]
+
+[tool.setuptools_scm]

california_midasapi-0.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+