# CluedIn IPython magic commands
This module provides IPython [magic](https://ipython.readthedocs.io/en/stable/interactive/python-ipython-diff.html#magics) commands for interacting with the CluedIn API.
```python
# Install the package.
%pip install cluedin-magic
```
```python
# Load the extension.
%load_ext cluedin_magic
```
```python
# Create a new CluedIn context from a JWT token.
api_token = '<your_token_here>'
ctx = %cluedin get-context --jwt %api_token
```
```python
# Find all entities with a specific entityType.
%cluedin search --context ctx --query +entityType:/Infrastructure/User
```
```python
# Find all entities with a specific entityType and limit the results.
%cluedin search --context ctx --query +entityType:/Infrastructure/User --limit 10
```
```python
# Complex query with multiple properties and limit the results.
%cluedin search --context ctx --query +entityType:/IMDb/Name -properties.imdb.name.deathYear:"\\\\N" --limit 10
```
```python
# Save the results of a query to a pandas DataFrame.
pd = %cluedin search --context ctx --query +entityType:/IMDb/Name +properties.imdb.name.birthYear:1981
```
Raw data
{
"_id": null,
"home_page": "https://github.com/romaklimenko/cluedin-magic",
"name": "cluedin-magic",
"maintainer": "Roman Klimenko",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": "roman@klimenko.dk",
"keywords": "cluedin, mdm, master data management, ipython, magic, jupyter",
"author": "Roman Klimenko",
"author_email": "roman@klimenko.dk",
"download_url": "https://files.pythonhosted.org/packages/0d/8e/490516ad115052c25538c4d2852f9546b1267d5df8691f7d0012efdbd996/cluedin_magic-0.1.1.tar.gz",
"platform": null,
"description": "# CluedIn IPython magic commands\n\nThis module provides IPython [magic](https://ipython.readthedocs.io/en/stable/interactive/python-ipython-diff.html#magics) commands for interacting with the CluedIn API.\n\n```python\n# Install the package.\n%pip install cluedin-magic\n```\n\n```python\n# Load the extension.\n%load_ext cluedin_magic\n```\n\n```python\n# Create a new CluedIn context from a JWT token.\napi_token = '<your_token_here>'\nctx = %cluedin get-context --jwt %api_token\n```\n\n```python\n# Find all entities with a specific entityType.\n%cluedin search --context ctx --query +entityType:/Infrastructure/User\n```\n\n```python\n# Find all entities with a specific entityType and limit the results.\n%cluedin search --context ctx --query +entityType:/Infrastructure/User --limit 10\n```\n\n```python\n# Complex query with multiple properties and limit the results.\n%cluedin search --context ctx --query +entityType:/IMDb/Name -properties.imdb.name.deathYear:\"\\\\\\\\N\" --limit 10\n```\n\n```python\n# Save the results of a query to a pandas DataFrame.\npd = %cluedin search --context ctx --query +entityType:/IMDb/Name +properties.imdb.name.birthYear:1981\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "IPython magic commands for CluedIn",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/romaklimenko/cluedin-magic",
"Repository": "https://github.com/romaklimenko/cluedin-magic"
},
"split_keywords": [
"cluedin",
" mdm",
" master data management",
" ipython",
" magic",
" jupyter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "45a5306c348c5834b77c41e90a3dc99fc5289b1bdc50f0c5ef32a951a4cd81b9",
"md5": "58a7279271b85027d33fd23391f9db89",
"sha256": "8af8e0fd298cf5e4963e986ce46b0f72c009ffc1cda3b3a0dedd44a9bde25a96"
},
"downloads": -1,
"filename": "cluedin_magic-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "58a7279271b85027d33fd23391f9db89",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 3879,
"upload_time": "2024-08-27T16:10:18",
"upload_time_iso_8601": "2024-08-27T16:10:18.986752Z",
"url": "https://files.pythonhosted.org/packages/45/a5/306c348c5834b77c41e90a3dc99fc5289b1bdc50f0c5ef32a951a4cd81b9/cluedin_magic-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d8e490516ad115052c25538c4d2852f9546b1267d5df8691f7d0012efdbd996",
"md5": "bde1db2ae0cca015c3d12b9a7b2bf89e",
"sha256": "fe3a334025514f37eba9618df8b97ae96dc7fa1159d88a2a77b8f88fd25e8b46"
},
"downloads": -1,
"filename": "cluedin_magic-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "bde1db2ae0cca015c3d12b9a7b2bf89e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 3287,
"upload_time": "2024-08-27T16:10:20",
"upload_time_iso_8601": "2024-08-27T16:10:20.624309Z",
"url": "https://files.pythonhosted.org/packages/0d/8e/490516ad115052c25538c4d2852f9546b1267d5df8691f7d0012efdbd996/cluedin_magic-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-27 16:10:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "romaklimenko",
"github_project": "cluedin-magic",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cluedin-magic"
}
JSON
