{"id":27741996,"url":"https://github.com/bhazel/octopus-energy-copilot","last_synced_at":"2025-04-28T16:38:34.180Z","repository":{"id":290015470,"uuid":"796202230","full_name":"BHazel/octopus-energy-copilot","owner":"BHazel","description":"Tools and AI for working with data from Octopus Energy.","archived":false,"fork":false,"pushed_at":"2025-04-26T09:58:58.000Z","size":98,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-26T10:34:05.936Z","etag":null,"topics":["artificial-intelligence","generative-ai","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BHazel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-05-05T08:46:26.000Z","updated_at":"2025-03-21T22:58:33.000Z","dependencies_parsed_at":"2025-04-26T10:45:21.349Z","dependency_job_id":null,"html_url":"https://github.com/BHazel/octopus-energy-copilot","commit_stats":null,"previous_names":["bhazel/octopus-energy-copilot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BHazel%2Foctopus-energy-copilot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BHazel%2Foctopus-energy-copilot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BHazel%2Foctopus-energy-copilot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BHazel%2Foctopus-energy-copilot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BHazel","download_url":"https://codeload.github.com/BHazel/octopus-energy-copilot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251347373,"owners_count":21575074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["artificial-intelligence","generative-ai","python"],"created_at":"2025-04-28T16:38:33.636Z","updated_at":"2025-04-28T16:38:34.166Z","avatar_url":"https://github.com/BHazel.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Octopus Energy Copilot\n\nTools and AI for working with data from Octopus Energy, energy bills and energy units.\n\n## Technologies\n\n* Python\n* LangChain\n* MCP\n\n## Concepts\n\nThe Copilot has been designed as a collection of standard Python reusable packages for use in front-end applications:\n\nPackage | Description\n-|-\n`bill` | Works with and extracts data from energy bills.\n`chat` | Chat infrastructure for working with Octopus Energy and generic energy data.\n`energy` | Energy data units and operations.\n`octopus_energy` | Infrastructure and models for working with the Octopus Energy API and data.\n\nA CLI, using the packages, is included in the `cli` directory.\n\n## Getting Started with the CLI\n\nAlthough it is optional, it is highly recommended to use a virtual environment.  In fact, the included MCP server configuration expects one in the `./.venv` folder.  A GNU Make target is included to create the virtual environment and set up a `.env` file:\n\n```bash\nmake init\n```\n\nThe CLI is also packaged as a standard Python package and can be built and installed from within the `cli` directory.  By default the CLI build and installation is run in _editable_ mode.\n\nThe simplest installation is to use GNU Make by running:\n\n```bash\nmake install\n```\n\nAlternatively, each step can be run individually, which is how the `Makefile` is written under the hood:\n\n```bash\npip install build           # Install build dependencies.\npip install --editable .    # Install CLI dependencies.\npython -m build             # Build and install CLI.\n```\n\nFor a non-editable build append `RELEASE=1` to the `make` command or remove `--editable` when installing the CLI dependencies.\n\nOnce built the CLI can be run with the `oec` command.  To get a list of the available commands, run:\n\n```bash\noec --help\n```\n\n### Configuration\n\nTo interact with the Octopus Energy API you need to set your API key, meter MPAN, serial number and account number as environment variables as outlined below:\n\nEnvironment Variable | Description\n-|-\n`OCTOPUS_ENERGY_ACCOUNT_NUMBER` | The Octopus Energy Account Number\n`OCTOPUS_ENERGY_API_KEY` | The Octopus Energy API Key\n`OCTOPUS_ENERGY_METER_MPAN` | The Electricity Meter MPAN\n`OCTOPUS_ENERGY_METER_SERIAL` | The Electricity Meter Serial Number\n\nThese can be configured via standard OS settings or by creating a `.env` file in the `cli` directory.  Instructions on the latter can be found on the [python-dotenv](https://pypi.org/project/python-dotenv/) site.  These can also be provided via CLI flags, however, this is not recommended.\n\nTo interact via the `chat` command you also need to set the following environment variables:\n\nEnvironment Variable | Description\n-|-\n`OPENAI_API_KEY` | The Open AI API Key\n`OPENAI_ORGANISATION_ID` | The Open AI Organisation Key","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbhazel%2Foctopus-energy-copilot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbhazel%2Foctopus-energy-copilot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbhazel%2Foctopus-energy-copilot/lists"}