-
Notifications
You must be signed in to change notification settings - Fork 453
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add github connection template
- Loading branch information
1 parent
2e589aa
commit 1cf6415
Showing
1 changed file
with
266 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,266 @@ | ||
{ | ||
"cells": [ | ||
{ | ||
"cell_type": "markdown", | ||
"id": "712c8bab-db51-4f89-9522-905ca8a0c189", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"<img width=\"8%\" alt=\"GitHub.png\" src=\"https://raw.githubusercontent.com/jupyter-naas/awesome-notebooks/master/.github/assets/logos/GitHub.png\" style=\"border-radius: 15%\">" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "a5b2c509-2c29-49e8-af91-4f3f1e386da3", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"# GitHub - Setup connection" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "d77fe283-4edd-42d3-a909-8e207d4b842f", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"**Tags:** #github #naas #secret #connection #setup" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "b90f2d91-c886-4e36-8265-b09d06bb1c7f", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"**Author:** [Florent Ravenel](https://www.linkedin.com/in/florent-ravenel)" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "6bbf7807-dda4-4b8a-b016-fe258a0fa33f", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"**Last update:** 2023-11-20 (Created: 2023-11-20)" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "214749fe-7f0b-4755-b7ea-1d200c234cc6", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"**Description:** This notebook help you setup your connection with GitHub and add required credentials to Naas secret. You will be able to establish a seamless connection to GitHub without the need to repeatedly redefine your credentials in variables by using `naas.secret.get()` in your notebook." | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "a1329bea-ad80-4981-874c-8776b11f89a8", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"**References:**\n", | ||
"- [Generate a personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)\n", | ||
"- [Naas Secret Documentation](https://site.naas.ai/docs/developers/jobs/secret)" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "cff349c8-2816-4ae4-9229-027c068eeb51", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"## Input" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "80266a9e-fe54-4f3e-aeb2-01483bbc53f9", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"### Import libraries" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "cc038b10-2679-42bc-909e-09a298339df4", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"outputs": [], | ||
"source": [ | ||
"import naas" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "30127040-e487-4115-8317-5084823b3a6f", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [ | ||
"variables" | ||
] | ||
}, | ||
"source": [ | ||
"### Setup variables\n", | ||
"**Mandatory**\n", | ||
"- `github_token`: GitHub personal access token. This value will be stored under the secret 'GITHUB_TOKEN'.\n", | ||
"\n", | ||
"**Optional**\n", | ||
"- `secrets`: Dict to add secrets to naas" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "8d86b8fb-2576-426d-a305-50043c24c23e", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [ | ||
"parameters" | ||
] | ||
}, | ||
"outputs": [], | ||
"source": [ | ||
"# Mandatory\n", | ||
"github_token = None\n", | ||
"\n", | ||
"# Optional\n", | ||
"secrets = {\n", | ||
" \"GITHUB_TOKEN\": github_token,\n", | ||
"}" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "1b0ae044-cac2-479f-b1fc-a3318696adf5", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"## Model" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "3aadae7f-fbe5-4f97-a6a9-6efe9dd1a42f", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"### Add secret" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "e235794a-6907-4f0e-ab2b-5aa6668a8d3b", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"outputs": [], | ||
"source": [ | ||
"for secret in secrets:\n", | ||
" new_value = secrets.get(secret)\n", | ||
" if new_value:\n", | ||
" naas.secret.add(secret, secrets.get(secret))" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "7c97931b-4ce8-46f9-a70c-45393c5669ee", | ||
"metadata": { | ||
"papermill": {}, | ||
"tags": [] | ||
}, | ||
"source": [ | ||
"## Output" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "760ec150-d79a-4208-adfe-d0336d443dc8", | ||
"metadata": {}, | ||
"source": [ | ||
"### Display result" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "4005faa2-a781-4805-9c08-74951e900d12", | ||
"metadata": { | ||
"tags": [] | ||
}, | ||
"outputs": [], | ||
"source": [ | ||
"df = naas.secret.list()\n", | ||
"df = df[df[\"name\"].isin(secrets.keys())]\n", | ||
"df" | ||
] | ||
} | ||
], | ||
"metadata": { | ||
"kernelspec": { | ||
"display_name": "Python 3", | ||
"language": "python", | ||
"name": "python3" | ||
}, | ||
"language_info": { | ||
"codemirror_mode": { | ||
"name": "ipython", | ||
"version": 3 | ||
}, | ||
"file_extension": ".py", | ||
"mimetype": "text/x-python", | ||
"name": "python", | ||
"nbconvert_exporter": "python", | ||
"pygments_lexer": "ipython3", | ||
"version": "3.9.6" | ||
}, | ||
"naas": { | ||
"notebook_id": "cc22b3eb0484bf2a314634076226daee8a2a74e35de569fa2fbd40dae558222c", | ||
"notebook_path": "GitHub/GitHub_Connect_from_Naas_Chat.ipynb" | ||
}, | ||
"papermill": { | ||
"default_parameters": {}, | ||
"environment_variables": {}, | ||
"parameters": {}, | ||
"version": "2.4.0" | ||
}, | ||
"widgets": { | ||
"application/vnd.jupyter.widget-state+json": { | ||
"state": {}, | ||
"version_major": 2, | ||
"version_minor": 0 | ||
} | ||
} | ||
}, | ||
"nbformat": 4, | ||
"nbformat_minor": 5 | ||
} |