Metadata-Version: 2.1
Name: cluedin-magic
Version: 0.1.2
Summary: IPython magic commands for CluedIn
Home-page: https://github.com/romaklimenko/cluedin-magic
License: MIT
Keywords: cluedin,mdm,master data management,ipython,magic,jupyter
Author: Roman Klimenko
Author-email: roman@klimenko.dk
Maintainer: Roman Klimenko
Maintainer-email: roman@klimenko.dk
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: cluedin (>=2.5.0,<3.0.0)
Requires-Dist: ipython (>=7.34.0,<9.0.0)
Requires-Dist: pandas (>=2.1.4,<2.2.2)
Project-URL: Repository, https://github.com/romaklimenko/cluedin-magic
Description-Content-Type: text/markdown

# 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
```
