ledgerdata 0.1.0.dev6__tar.gz

ledgerdata-0.1.0.dev6/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+*.lcov
+.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
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical 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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

ledgerdata-0.1.0.dev6/.python-version

@@ -0,0 +1 @@
+3.12

ledgerdata-0.1.0.dev6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 LEDGER-project
+
+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.

ledgerdata-0.1.0.dev6/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.5
+Name: ledgerdata
+Version: 0.1.0.dev6
+Summary: Python client for LEDGER database
+Author-email: Luke Gloege <lucas.gloege@yale.edu>
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pandas>=3.0.6
+Requires-Dist: psycopg>=3.3.6
+Requires-Dist: pydantic>=2.14.1
+Requires-Dist: requests>=2.34.2
+Requires-Dist: ruff>=0.17.2
+Description-Content-Type: text/markdown
+
+# ledgerdata: The LEDGER Python Client
+
+This Repo contains the LEDGER Python Client
+
+## Installation
+
+```bash
+uv add git+https://github.com/LEDGER-project/ledgerdata.git@main 
+```
+
+or with pip
+
+```bash
+pip install git+https://github.com/LEDGER-project/ledgerdata.git@main
+```
+
+## Documentation
+
+The official documentation for the entire LEDGER project is available at: [https://ledger-project.github.io/](https://ledger-project.github.io/)

ledgerdata-0.1.0.dev6/README.md

@@ -0,0 +1,19 @@
+# ledgerdata: The LEDGER Python Client
+
+This Repo contains the LEDGER Python Client
+
+## Installation
+
+```bash
+uv add git+https://github.com/LEDGER-project/ledgerdata.git@main 
+```
+
+or with pip
+
+```bash
+pip install git+https://github.com/LEDGER-project/ledgerdata.git@main
+```
+
+## Documentation
+
+The official documentation for the entire LEDGER project is available at: [https://ledger-project.github.io/](https://ledger-project.github.io/)

ledgerdata-0.1.0.dev6/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "ledgerdata"
+version = "0.1.0.dev6"
+description = "Python client for LEDGER database"
+readme = "README.md"
+authors = [
+    { name = "Luke Gloege", email = "lucas.gloege@yale.edu" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "httpx>=0.28.1",
+    "pandas>=3.0.6",
+    "psycopg>=3.3.6",
+    "pydantic>=2.14.1",
+    "requests>=2.34.2",
+    "ruff>=0.17.2",
+]
+
+[project.scripts]
+ledgerdata = "ledgerdata:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

ledgerdata-0.1.0.dev6/src/ledgerdata/__init__.py

@@ -0,0 +1,15 @@
+"""
+Set up module access for the base package
+"""
+
+from .actors import Actors
+from .client import Client
+from .datasource import Datasource
+from .emissions import Emissions
+from .gdp import GDP
+from .initiatives import Initiatives
+from .population import Population
+from .sector import Sector
+from .targets import Targets
+
+__all__ = ["GDP", "Actors", "Client", "Datasource", "Emissions", "Initiatives", "Population", "Sector", "Targets"]

ledgerdata-0.1.0.dev6/src/ledgerdata/actors.py

@@ -0,0 +1,204 @@
+import warnings
+
+import httpx
+import requests
+from pydantic.dataclasses import dataclass
+
+from .base import Base
+
+
+@dataclass
+class Actors(Base):
+    """Provides methods to retrieve actor and actor-part data from the LEDGER API."""
+
+    def get_all_actors(self, *args, **kwargs):
+        """Retrieve all actors.
+
+        Sends a GET request to the `/actors` endpoint and returns the response
+        as a JSON dictionary.
+
+        Returns:
+            dict: A JSON response containing actor data.
+        """
+        endpoint = "/actor"
+        url = f"{self.server}{endpoint}"
+        headers = {"Accept": "application/json"}
+        # Add query parameters as a dict
+        response = requests.get(url, headers=headers).json()
+        # data_list = response.get("data", None)
+        return response
+
+    def parts_of_actor(self, actor_id=str, type: str | None = None, *args, **kwargs):
+        """Retrieve parts (sub-actors) of a given actor.
+
+        Sends a GET request to the `/parts_of/{actor_id}` endpoint and returns
+        the response as a JSON dictionary.
+
+        Args:
+            actor_id (str): The code for the actor whose parts you want to retrieve.
+            type (Optional[str]): Optional filter for part type.
+            *args: Additional positional arguments (currently unused).
+            **kwargs: Additional keyword arguments (currently unused).
+
+        Returns:
+            dict: A JSON response containing actor-part data.
+        """
+        endpoint = f"/actor/{actor_id}/parts"
+        url = f"{self.server}{endpoint}"
+        headers = {"Accept": "application/json"}
+        params = {"type": type} if type else {}
+        response = requests.get(url, headers=headers, params=params).json()
+        # data_list = response.get("data", None)
+        return response
+
+    def population(self, actor_id=str, *args, **kwargs):
+        """Retrieve actor population
+
+        Sends a GET request to the `/actor/{actor_id}/population` endpoint and returns
+        the response as a JSON dictionary.
+
+        Args:
+            actor_id (str): The code for the actor whose parts you want to retrieve.
+            *args: Additional positional arguments (currently unused).
+            **kwargs: Additional keyword arguments (currently unused).
+
+        Returns:
+            dict: A JSON response containing actor-part data.
+        """
+        endpoint = f"/actor/{actor_id}/population"
+        url = f"{self.server}{endpoint}"
+        headers = {"Accept": "application/json"}
+        response = requests.get(url, headers=headers).json()
+        return response
+
+    def gdp(self, actor_id=str, *args, **kwargs):
+        """Retrieve actor population
+
+        Sends a GET request to the `/actor/{actor_id}/gdp` endpoint and returns
+        the response as a JSON dictionary.
+
+        Args:
+            actor_id (str): The code for the actor whose parts you want to retrieve.
+            *args: Additional positional arguments (currently unused).
+            **kwargs: Additional keyword arguments (currently unused).
+
+        Returns:
+            dict: A JSON response containing actor-part data.
+        """
+        endpoint = f"/actor/{actor_id}/gdp"
+        url = f"{self.server}{endpoint}"
+        headers = {"Accept": "application/json"}
+        response = requests.get(url, headers=headers).json()
+        return response
+
+    def energy_consumption(self, actor_id=str, *args, **kwargs):
+        """Retrieve actor population
+
+        Sends a GET request to the `/actor/{actor_id}/energy_consumption` endpoint and returns
+        the response as a JSON dictionary.
+
+        Args:
+            actor_id (str): The code for the actor whose parts you want to retrieve.
+            *args: Additional positional arguments (currently unused).
+            **kwargs: Additional keyword arguments (currently unused).
+
+        Returns:
+            dict: A JSON response containing actor-part data.
+        """
+        endpoint = f"/actor/{actor_id}/energy_consumption"
+        url = f"{self.server}{endpoint}"
+        headers = {"Accept": "application/json"}
+        response = requests.get(url, headers=headers).json()
+        return response
+
+    def targets(self, actor_id=str, *args, **kwargs):
+        """Retrieve actor population
+
+        Sends a GET request to the `/actor/{actor_id}/targets` endpoint and returns
+        the response as a JSON dictionary.
+
+        Args:
+            actor_id (str): The code for the actor whose parts you want to retrieve.
+            *args: Additional positional arguments (currently unused).
+            **kwargs: Additional keyword arguments (currently unused).
+
+        Returns:
+            dict: A JSON response containing actor-part data.
+        """
+        endpoint = f"/actor/{actor_id}/targets"
+        url = f"{self.server}{endpoint}"
+        headers = {"Accept": "application/json"}
+        response = requests.get(url, headers=headers).json()
+        return response
+
+    def emissions(self, actor_id=str, ignore_warnings: bool = False, *args, **kwargs):
+        """Retrieve actor population
+
+        Sends a GET request to the `/actor/{actor_id}/emissions` endpoint and returns
+        the response as a JSON dictionary.
+
+        Args:
+            actor_id (str): The code for the actor whose parts you want to retrieve.
+            *args: Additional positional arguments (currently unused).
+            **kwargs: Additional keyword arguments (currently unused).
+
+        Returns:
+            dict: A JSON response containing actor-part data.
+        """
+        (
+            warnings.simplefilter("ignore")
+            if ignore_warnings
+            else warnings.simplefilter("default")
+        )
+        endpoint = f"/actor/{actor_id}/emissions"
+        url = f"{self.server}{endpoint}"
+        headers = {"Accept": "application/json"}
+        response = requests.get(url, headers=headers).json()
+        return response
+
+
+    def emissions_total_sector(self, actor_id=str, ignore_warnings: bool = False, *args, **kwargs):
+        """Retrieve actor population
+
+        Sends a GET request to the `/actor/{actor_id}/emissions_total_sector` endpoint and returns
+        the response as a JSON dictionary.
+
+        Args:
+            actor_id (str): The code for the actor whose parts you want to retrieve.
+            *args: Additional positional arguments (currently unused).
+            **kwargs: Additional keyword arguments (currently unused).
+
+        Returns:
+            dict: A JSON response containing actor-part data.
+        """
+        (
+            warnings.simplefilter("ignore")
+            if ignore_warnings
+            else warnings.simplefilter("default")
+        )
+        endpoint = f"/actor/{actor_id}/emissions_total_sector"
+        url = f"{self.server}{endpoint}"
+        headers = {"Accept": "application/json"}
+        response = requests.get(url, headers=headers).json()
+        return response
+    
+    async def emissions_async(
+        self, actor_id: str, ignore_warnings: bool = False, *args, **kwargs
+    ):
+        """Retrieve actor emissions asynchronously."""
+        if ignore_warnings:
+            warnings.simplefilter("ignore")
+        else:
+            warnings.simplefilter("default")
+
+        endpoint = f"/actor/{actor_id}/emissions"
+        url = f"{self.server}{endpoint}"
+        headers = {
+            "Accept": "application/json",
+            "User-Agent": "python-httpx/1.0",
+        }
+
+        async with httpx.AsyncClient() as client:
+            response = await client.get(url, headers=headers)
+            response.raise_for_status()
+            return response.json()

ledgerdata-0.1.0.dev6/src/ledgerdata/base.py

@@ -0,0 +1,23 @@
+from enum import Enum
+
+from pydantic import HttpUrl
+from pydantic.dataclasses import dataclass
+
+
+class Env(str, Enum):
+    dev = "dev"
+    prod = "prod"
+
+
+@dataclass
+class Base:
+    version: str = "/api/v0"
+    env: Env = Env.prod
+
+    def __post_init__(self):
+        urls = {
+            Env.dev: "http://127.0.0.1:8000",
+            Env.prod: "https://orca-app-5ivtt.ondigitalocean.app",
+        }
+        self.base_url: HttpUrl = urls[self.env]
+        self.server = f"{self.base_url}{self.version}"