[Sample]: Jupyter notebook Demo of web API #114
Conversation
Willmish
changed the title
Codecov Report
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more @@ Coverage Diff @@
## dev #114 +/- ##
=======================================
Coverage 79.57% 79.57%
=======================================
Files 69 69
Lines 2384 2384
Branches 242 242
=======================================
Hits 1897 1897
Misses 407 407
Partials 80 80
|
Willmish
force-pushed
the
demo_sdk_notebook
branch
from
fa99a19 to
986aa49
Compare
|
@danuw are you able to review/try it out ? |
|
This is currently blocked by #198 |
Willmish
force-pushed
the
demo_sdk_notebook
branch
from
a1c922c to
35d4cb7
Compare
|
@Willmish - is this still working current on the SDK? Can you please test and happy to approve, just want to make sure it hasn't broken. |
Temporarily add python client. Add test_api.py: Python test script. Signed-off-by: Szymon Duchniewicz <[email protected]>
Add steps to the scrathpad notebook. Signed-off-by: Szymon Duchniewicz <[email protected]>
Add .env.template. Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
* Adapt notebook to work with v1.0 of the SDK. * Add requirements.txt. Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
…otations. * Issue reference: Green-Software-Foundation#198 * Produces filters now accept application/json; charset=utf-8 Signed-off-by: Szymon Duchniewicz <[email protected]>
Signed-off-by: Szymon Duchniewicz <[email protected]>
Willmish
force-pushed
the
demo_sdk_notebook
branch
from
35d4cb7 to
01694b4
Compare
|
This a stale pull request. Please review, update or/and close as necessary. |
|
Waiting until decision made regarding pip python packages being distributed for ca sdk api |
|
I don't think you should wait - just pointing at doc on how to generate (which I believe you already had) from localhost is good enough for people to use. People could benefit from this already and this can always be updated when and if pip exist... |
|
Maybe host on google colab with python packages available at a public url |
|
This a stale pull request. Please review, update or/and close as necessary. |
Summary
Adds a jupyter notebook demo along with a setup guide for the environment. This an Example for the
/sampledirectory, to showcase the usage of a deployed Carbon Aware Web API and a Python SDK generated with OpenAPI generator. The notebook goes through an example process of making Carbon Aware decisions around Cloud deployments, by showcasing benefits of time shifting and location shifting.Changes
samplesfolder:python-jupyter-notebook-webapi.README.mdfile containing a short description of the demo along with a setup guide.requirements.txtfile for the conda/python environment..env.templatefile to be used as a template for a new.envfile to provide URL for the deployed web API.Carbon_aware_SDK_demo.ipynbcontaining the described demo, with results stored.Checklist
Are there API Changes?
No.
Is this a breaking change?
No.