{"id":20200798,"url":"https://github.com/openclimatefix/india-api","last_synced_at":"2025-04-10T11:21:14.122Z","repository":{"id":213556627,"uuid":"734022554","full_name":"openclimatefix/india-api","owner":"openclimatefix","description":"API India solar and wind data","archived":false,"fork":false,"pushed_at":"2025-04-04T16:05:01.000Z","size":193,"stargazers_count":5,"open_issues_count":10,"forks_count":22,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T16:32:16.759Z","etag":null,"topics":[],"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/openclimatefix.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},"funding":{"github":["openclimatefix"],"patreon":null,"open_collective":"openclimatefix","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2023-12-20T17:13:02.000Z","updated_at":"2025-04-04T16:05:05.000Z","dependencies_parsed_at":"2023-12-21T18:29:11.419Z","dependency_job_id":"7bb94caf-1ce9-446d-8251-f8d6ef2ca8d3","html_url":"https://github.com/openclimatefix/india-api","commit_stats":null,"previous_names":["openclimatefix/fake-api"],"tags_count":56,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclimatefix%2Findia-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclimatefix%2Findia-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclimatefix%2Findia-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclimatefix%2Findia-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openclimatefix","download_url":"https://codeload.github.com/openclimatefix/india-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208603,"owners_count":21065203,"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":[],"created_at":"2024-11-14T04:45:43.088Z","updated_at":"2025-04-10T11:21:14.114Z","avatar_url":"https://github.com/openclimatefix.png","language":"Python","funding_links":["https://github.com/sponsors/openclimatefix","https://opencollective.com/openclimatefix"],"categories":[],"sub_categories":[],"readme":"# India API\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\nDefines an API to help with building frontends pertaining to displaying wind and solar data.\n\n## Running the service\n\n### Configuration\n\nThe application is configured via the use of environment variables.\nFor the environment variable please set: DB_URL in bash\nCurrently there is only one source adaptor\nso there is nothing to configure.\n\n### Using docker\n\nYou can either download the latest image from GitHub container registry:\n\n```sh\n$ docker run ghcr.io/openclimatefix/india-api:latest\n```\n\nOr build and run locally using the Containerfile:\n\n```sh\n$ docker build -t india-api .\n$ docker run india-api\n```\n\n### Using python(v3.11.x)\n\nClone the repository,\nand create a new virtual environment with your favorite environment manager.\nInstall the dependencies with\n\n```\n$ pip install -e .\n```\n\nThe service is then runnable via the command `india-api`.\nYou should see the following output:\n\n```shell\nINFO:     Started server process [87312]\nINFO:     Waiting for application startup.\nINFO:     Application startup complete.\nINFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)\n```\n\nThe API should then be accessible at `http://localhost:8000`,\nand the docs at `http://localhost:8000/docs`.\n\n\n## Development\n\nClone the repository,\nand create a new environment with your favorite environment manager.\nInstall all the dependencies with\n\n```\npip install -e \".[all]\"\n```\n\nYou can run the service with the command `india-api`.\nChanges will be hot-reloaded by the server.\n\n\n## Running Tests\n\nMake sure that you have ```pytest```\nand ```testcontainers``` installed.\n\nThen run the tests using\n```\npytest\n```\n\n\n## Known Bugs\n\nThere may be some issues when\ninstalling this with windows.\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/rahul-maurya11b\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/98907006?v=4?s=100\" width=\"100px;\" alt=\"Rahul Maurya\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eRahul Maurya\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/openclimatefix/india-api/commits?author=rahul-maurya11b\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/DubraskaS\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/87884444?v=4?s=100\" width=\"100px;\" alt=\"Dubraska Solórzano\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eDubraska Solórzano\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/openclimatefix/india-api/commits?author=DubraskaS\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/ProfessionalCaddie\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/180212671?v=4?s=100\" width=\"100px;\" alt=\"Nicholas Tucker\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eNicholas Tucker\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/openclimatefix/india-api/commits?author=ProfessionalCaddie\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/devsjc\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/47188100?v=4?s=100\" width=\"100px;\" alt=\"devsjc\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003edevsjc\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/openclimatefix/india-api/commits?author=devsjc\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://suvanbanerjee.github.io\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/104707806?v=4?s=100\" width=\"100px;\" alt=\"Suvan Banerjee\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSuvan Banerjee\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/openclimatefix/india-api/commits?author=suvanbanerjee\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://anaskhan.me\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/83116240?v=4?s=100\" width=\"100px;\" alt=\"Anas Khan\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAnas Khan\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#infra-anxkhn\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenclimatefix%2Findia-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenclimatefix%2Findia-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenclimatefix%2Findia-api/lists"}