# Pinecone helpers for notebooks
This package contains helper functions for working with Pinecone in the context of a Jupyter or
Google Colab notebook.
## Google Colab
### Authenticate
This helper function displays a widget to allow the user to authenticate with Pinecone. Once the
user authenticates, they are prompted to select the Pinecone organization and project that they want
to grant access to. An API key is then generated and set as the environment variable
`PINECONE_API_KEY`.
#### Usage
To display the authentication widget:
```py
from pinecone_notebooks.colab import Authenticate
Authenticate()
```
Note that any usage of the API key should take place in a later cell. The user must complete the
authentication flow before the `PINECONE_API_KEY` environment variable can be used.
```py
from pinecone import Pinecone
api_key = os.environ.get('PINECONE_API_KEY')
pinecone_client = Pinecone(api_key=api_key)
# ... proceed to use pinecone_client to create indexes, upload data, query, etc.
```
##### source_tag
The `Authenticate` function has an optional `source_tag` parameter. Pinecone partners should set
this value to receive attribution credit for users of their notebooks who signup to Pinecone.
```py
from pinecone_notebooks.colab import Authenticate
Authenticate(source_tag='MyAwesomeApp')
```
## Jupyter
Coming soon!
Raw data
{
"_id": null,
"home_page": "https://www.pinecone.io",
"name": "pinecone-notebooks",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "Pinecone, vector, database, cloud, jupyter, colab, notebooks",
"author": "Pinecone Systems, Inc.",
"author_email": "support@pinecone.io",
"download_url": "https://files.pythonhosted.org/packages/ef/eb/3b8d32be22fc7cb8483db0c2bf74ac812159ed7414ae9003a1b1e39396d6/pinecone_notebooks-0.1.0.tar.gz",
"platform": null,
"description": "# Pinecone helpers for notebooks\nThis package contains helper functions for working with Pinecone in the context of a Jupyter or\nGoogle Colab notebook.\n\n## Google Colab\n### Authenticate\nThis helper function displays a widget to allow the user to authenticate with Pinecone. Once the\nuser authenticates, they are prompted to select the Pinecone organization and project that they want\nto grant access to. An API key is then generated and set as the environment variable\n`PINECONE_API_KEY`.\n#### Usage\nTo display the authentication widget:\n```py\nfrom pinecone_notebooks.colab import Authenticate\n\nAuthenticate()\n```\nNote that any usage of the API key should take place in a later cell. The user must complete the\nauthentication flow before the `PINECONE_API_KEY` environment variable can be used.\n```py\nfrom pinecone import Pinecone\n\napi_key = os.environ.get('PINECONE_API_KEY')\npinecone_client = Pinecone(api_key=api_key)\n\n# ... proceed to use pinecone_client to create indexes, upload data, query, etc.\n```\n##### source_tag\nThe `Authenticate` function has an optional `source_tag` parameter. Pinecone partners should set\nthis value to receive attribution credit for users of their notebooks who signup to Pinecone.\n```py\nfrom pinecone_notebooks.colab import Authenticate\n\nAuthenticate(source_tag='MyAwesomeApp')\n```\n\n## Jupyter\nComing soon!\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Helpers for using Pinecone with notebooks",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://pinecone.io/docs",
"Homepage": "https://www.pinecone.io"
},
"split_keywords": [
"pinecone",
" vector",
" database",
" cloud",
" jupyter",
" colab",
" notebooks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8fee38d9b4c6dc1332998fc943ef9c1833df42be1a57e068a60f4d188cc02f4a",
"md5": "4c44b31ff6bc6d00070ad37934bfde63",
"sha256": "813ed2d363f3f8a5508ffc61136028d034514aa8162950e2e8cc0c131b9b074b"
},
"downloads": -1,
"filename": "pinecone_notebooks-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c44b31ff6bc6d00070ad37934bfde63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 7285,
"upload_time": "2024-04-23T17:38:18",
"upload_time_iso_8601": "2024-04-23T17:38:18.842560Z",
"url": "https://files.pythonhosted.org/packages/8f/ee/38d9b4c6dc1332998fc943ef9c1833df42be1a57e068a60f4d188cc02f4a/pinecone_notebooks-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "efeb3b8d32be22fc7cb8483db0c2bf74ac812159ed7414ae9003a1b1e39396d6",
"md5": "67e0e7d0ccd5d102a97576551c088b43",
"sha256": "ef5affff5a7186b392eb16900fd8d264501ab3081492027d083e00d633c9e281"
},
"downloads": -1,
"filename": "pinecone_notebooks-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "67e0e7d0ccd5d102a97576551c088b43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 6292,
"upload_time": "2024-04-23T17:38:20",
"upload_time_iso_8601": "2024-04-23T17:38:20.083529Z",
"url": "https://files.pythonhosted.org/packages/ef/eb/3b8d32be22fc7cb8483db0c2bf74ac812159ed7414ae9003a1b1e39396d6/pinecone_notebooks-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 17:38:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pinecone-notebooks"
}
JSON