From aa8d650d14d58379c508c3a75afd3ca4e9898fa9 Mon Sep 17 00:00:00 2001 From: anxkhn Date: Tue, 14 Jan 2025 15:10:05 +0530 Subject: [PATCH 1/3] update docker instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 30bfe20..735be69 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ so there is nothing to configure. Download the latest image from github container regiimage from github container registry: ```sh -$ docker run ghcr.io/openclimatefix/fake-api:latest +$ docker run ghcr.io/openclimatefix/india-api:latest ``` ### Using python(v3.11.x) From 628ebd26f3db9cc8503dfdd0820c2ed8cc274cd0 Mon Sep 17 00:00:00 2001 From: anxkhn Date: Tue, 14 Jan 2025 15:12:24 +0530 Subject: [PATCH 2/3] add dockerignore file --- .dockerignore | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 .dockerignore diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..b7be024 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,89 @@ +# Git +.git +.gitignore +.gitattributes + + +# CI +.codeclimate.yml +.travis.yml +.taskcluster.yml + +# Docker +docker-compose.yml +Dockerfile +.docker +.dockerignore + +# Byte-compiled / optimized / DLL files +**/__pycache__/ +**/*.py[cod] + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# 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/ +.coverage +.cache +nosetests.xml +coverage.xml + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Virtual environment +.env +.venv/ +venv/ + +# PyCharm +.idea + +# Python mode for VIM +.ropeproject +**/.ropeproject + +# Vim swap files +**/*.swp + +# VS Code +.vscode/ \ No newline at end of file From 7fdc1fc9981cded7ca4f9b5180597f1e3919273d Mon Sep 17 00:00:00 2001 From: anxkhn Date: Tue, 14 Jan 2025 15:14:14 +0530 Subject: [PATCH 3/3] add: locally using the Containerfile --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 735be69..1461ce5 100644 --- a/README.md +++ b/README.md @@ -15,12 +15,19 @@ so there is nothing to configure. ### Using docker -Download the latest image from github container regiimage from github container registry: +You can either download the latest image from GitHub container registry: ```sh $ docker run ghcr.io/openclimatefix/india-api:latest ``` +Or build and run locally using the Containerfile: + +```sh +$ docker build -t india-api . +$ docker run india-api +``` + ### Using python(v3.11.x) Clone the repository,