Added scaffolding for initial forecast app

.bumpversion.cfg

@@ -0,0 +1,13 @@
+[bumpversion]
+current_version = 0.1.0
+commit = True
+tag = True
+message = Bump version: {current_version} → {new_version} [ci skip]
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
+
+[bumpversion:file:india_forecast_app/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"

.dockerignore

@@ -0,0 +1,5 @@
+*
+!india_forecast_app
+!poetry.lock
+!pyproject.toml
+!README.md

.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI Pipeline for SDK - Python
+
+on: push
+
+jobs:
+  lint_and_test:
+	name: Lint the code and run the tests
+	runs-on: ubuntu-latest
+	steps:
+	  - name: Check out the repo
+		uses: actions/checkout@v2
+
+	  - name: Install poetry
+		run: pipx install poetry==1.7.1
+
+	  - name: Install python
+		uses: actions/setup-python@v4
+		with:
+		  python-version: '3.9'
+		  cache: poetry
+
+	  - name: Install python dependencies
+		run: poetry install
+
+	  - name: Lint
+		run: make lint
+
+	  - name: Run the tests
+		run: poetry run pytest --cov=india_forecast_app --cov-report=xml
+
+	  - name: Upload coverage to Codecov
+		uses: codecov/codecov-action@v3
+
+  release:
+	needs: [lint_and_test]
+	if: github.ref_name == 'main'
+  	uses: openclimatefix/.github/.github/workflows/[email protected]
+  	secrets:
+	  DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+	  DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
+	  PAT_TOKEN: ${{ secrets.PAT_TOKEN }}
+  	with:
+	  image_base_name: india_forecast_app

.gitignore

@@ -0,0 +1,137 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+.idea/
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+# OS stuff
+.DS_Store
+
+# IDE stuff
+.nova/
+.vscode/
+.idea/

Dockerfile

@@ -0,0 +1,34 @@
+FROM python:3.9-slim as base
+
+ENV PYTHONFAULTHANDLER=1 \
+	PYTHONHASHSEED=random \
+	PYTHONUNBUFFERED=1
+
+WORKDIR /app
+
+FROM base as builder
+
+ENV PIP_DEFAULT_TIMEOUT=100 \
+	PIP_DISABLE_PIP_VERSION_CHECK=1 \
+	PIP_NO_CACHE_DIR=1 \
+	POETRY_VERSION=1.7.1
+
+RUN pip install "poetry==$POETRY_VERSION"
+
+RUN python -m venv /venv
+
+COPY pyproject.toml poetry.lock README.md .
+RUN . /venv/bin/activate && poetry install --no-dev --no-root
+
+COPY india_forecast_app ./india_forecast_app
+RUN . /venv/bin/activate && poetry build
+
+FROM base as final
+
+ENV PATH="/venv/bin:$PATH"
+
+COPY --from=builder /venv /venv
+COPY --from=builder /app/dist .
+RUN . /venv/bin/activate && pip install *.whl
+
+ENTRYPOINT ["app"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Open Climate Fix
+
+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.

Makefile

@@ -0,0 +1,25 @@
+#
+# This mostly contains shortcut for multi-command steps.
+#
+SRC = india_forecast_app tests
+
+.PHONY: lint
+lint:
+	poetry run ruff $(SRC)
+	poetry run black --check $(SRC)
+	poetry run isort --check $(SRC)
+
+
+.PHONY: format
+format:
+	poetry run ruff --fix $(SRC)
+	poetry run black $(SRC)
+	poetry run isort $(SRC)
+
+.PHONY: test
+test:
+	poetry run pytest tests
+
+.PHONY: docker.build
+docker.build:
+	docker build -t ocf/india-forecast-app .

README.md

@@ -0,0 +1,39 @@
+<h1 align="center">india-forecast-app</h1>
+
+Runs wind and PV forecasts for India and saves to database
+
+## Install dependencies (requires [poetry](https://python-poetry.org/))
+
+```
+poetry install
+```
+
+## Linting and formatting
+
+Lint with:
+```
+make lint
+```
+
+Format code with:
+```
+make format
+```
+
+## Running tests
+
+```
+make test
+```
+
+## Building and running in [Docker](https://www.docker.com/)
+
+Build the Docker image
+```
+make docker.build
+```
+
+Run the image (this example invokes app.py and passes the help flag)
+```
+docker run -it --rm ocf/india-forecast-app --help
+```

india_forecast_app/__init__.py

@@ -0,0 +1,2 @@
+"""India Forecast App"""
+__version__ = "0.1.0"

india_forecast_app/app.py

@@ -0,0 +1,10 @@
+import click
+
+@click.command()
+@click.option("--site", help="Site ID")
+def app(site):
+	"""Runs the forecast for a given site"""
+	print(f"Running forecast for site: {site}")
+
+if __name__ == "__main__":
+	app()