# notebookutils-interface
Provides implementations and interfaces upon the dummy notebook utils from Microsoft in Synapse Analytics and Fabric to support local development with notebookutils
Based on the dummy-notebookutils from pypi: https://pypi.org/project/dummy-notebookutils/ and aims to add functionality to run in a local development environment.
## Sample usage
```python
from notebookutils import mssparkutils
files = mssparkutils.fs.ls("notebookutils/")
print(files)
```
Output of the sample:
[FileInfo(path=notebookutils/credentials.py, name=credentials.py, size=212), FileInfo(path=notebookutils/fabricClient.py, name=fabricClient.py, size=309), FileInfo(path=notebookutils/fs.py, name=fs.py, size=1004), FileInfo(path=notebookutils/lakehouse.py, name=lakehouse.py, size=654), FileInfo(path=notebookutils/mssparkutils, name=mssparkutils, size=None), FileInfo(path=notebookutils/notebook.py, name=notebook.py, size=681), FileInfo(path=notebookutils/runtime.py, name=runtime.py, size=123), FileInfo(path=notebookutils/session.py, name=session.py, size=61), FileInfo(path=notebookutils/warehouse.py, name=warehouse.py, size=438), FileInfo(path=notebookutils/workspace.py, name=workspace.py, size=449), FileInfo(path=notebookutils/__init__.py, name=__init__.py, size=205), FileInfo(path=notebookutils/__pycache__, name=__pycache__, size=None)]
## What can this interface be used for
- Actual mssparkutils.fs implementation to interact with the local file system
- fs implementation doesn't support Hadoop or Cloud Storage yet such as Azure Data Lake (can be added later)
- Dummy API Calls to mssparkutils for most functionality
# Important Notes
This interface should be used instead of dummy-notebookutils from Microsoft, as they have the same module path notebookutils and notebookutils.mssparkutils.
In Synapse and Fabric this install is not required, the same imports as in the sample can be used but will then point to the actual notebookutils and notebookutils.mssparkutils installed natively in Fabric/Synapse.
Raw data
{
"_id": null,
"home_page": null,
"name": "notebookutils-interface",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "notebookutils, Synapse, Fabric",
"author": "The Scripting Guy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/0d/96/9038a7f99ad1821a9289bc57580edf173b48472212c46228d999d31e05ec/notebookutils_interface-0.2.2.tar.gz",
"platform": null,
"description": "# notebookutils-interface\nProvides implementations and interfaces upon the dummy notebook utils from Microsoft in Synapse Analytics and Fabric to support local development with notebookutils\n\nBased on the dummy-notebookutils from pypi: https://pypi.org/project/dummy-notebookutils/ and aims to add functionality to run in a local development environment.\n\n## Sample usage\n```python\nfrom notebookutils import mssparkutils\n\nfiles = mssparkutils.fs.ls(\"notebookutils/\")\n\nprint(files)\n```\n\nOutput of the sample:\n[FileInfo(path=notebookutils/credentials.py, name=credentials.py, size=212), FileInfo(path=notebookutils/fabricClient.py, name=fabricClient.py, size=309), FileInfo(path=notebookutils/fs.py, name=fs.py, size=1004), FileInfo(path=notebookutils/lakehouse.py, name=lakehouse.py, size=654), FileInfo(path=notebookutils/mssparkutils, name=mssparkutils, size=None), FileInfo(path=notebookutils/notebook.py, name=notebook.py, size=681), FileInfo(path=notebookutils/runtime.py, name=runtime.py, size=123), FileInfo(path=notebookutils/session.py, name=session.py, size=61), FileInfo(path=notebookutils/warehouse.py, name=warehouse.py, size=438), FileInfo(path=notebookutils/workspace.py, name=workspace.py, size=449), FileInfo(path=notebookutils/__init__.py, name=__init__.py, size=205), FileInfo(path=notebookutils/__pycache__, name=__pycache__, size=None)]\n\n## What can this interface be used for\n- Actual mssparkutils.fs implementation to interact with the local file system\n- fs implementation doesn't support Hadoop or Cloud Storage yet such as Azure Data Lake (can be added later)\n- Dummy API Calls to mssparkutils for most functionality\n\n# Important Notes\nThis interface should be used instead of dummy-notebookutils from Microsoft, as they have the same module path notebookutils and notebookutils.mssparkutils.\n\nIn Synapse and Fabric this install is not required, the same imports as in the sample can be used but will then point to the actual notebookutils and notebookutils.mssparkutils installed natively in Fabric/Synapse.\n",
"bugtrack_url": null,
"license": null,
"summary": "A short description of your project.",
"version": "0.2.2",
"project_urls": {
"repository": "https://github.com/TheScriptingGuy/notebookutils-interface"
},
"split_keywords": [
"notebookutils",
" synapse",
" fabric"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4cf9f89b0791fe23a22173ee424dd0345d059e522447b0dbdf213ec66bb78c25",
"md5": "ea3ee929a4246e0e43894e2ef61e76af",
"sha256": "da5bc347530bf5e04b686876de63fabf8faf55b429efb9ca1438c143b5d30450"
},
"downloads": -1,
"filename": "notebookutils_interface-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea3ee929a4246e0e43894e2ef61e76af",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9868,
"upload_time": "2024-07-27T22:17:20",
"upload_time_iso_8601": "2024-07-27T22:17:20.236142Z",
"url": "https://files.pythonhosted.org/packages/4c/f9/f89b0791fe23a22173ee424dd0345d059e522447b0dbdf213ec66bb78c25/notebookutils_interface-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d969038a7f99ad1821a9289bc57580edf173b48472212c46228d999d31e05ec",
"md5": "92d10a81ba93f554d99ae8dbb5f97f00",
"sha256": "1d9215ca2e398ac26d09b593afe6f56be9471b1d92cf2a25165d79be36f179c2"
},
"downloads": -1,
"filename": "notebookutils_interface-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "92d10a81ba93f554d99ae8dbb5f97f00",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6410,
"upload_time": "2024-07-27T22:17:21",
"upload_time_iso_8601": "2024-07-27T22:17:21.522231Z",
"url": "https://files.pythonhosted.org/packages/0d/96/9038a7f99ad1821a9289bc57580edf173b48472212c46228d999d31e05ec/notebookutils_interface-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-27 22:17:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TheScriptingGuy",
"github_project": "notebookutils-interface",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pyarrow",
"specs": [
[
"==",
"15.0.0"
]
]
},
{
"name": "fsspec",
"specs": []
},
{
"name": "numpy",
"specs": [
[
"==",
"1.26.4"
]
]
}
],
"lcname": "notebookutils-interface"
}
JSON
