Metadata-Version: 2.4
Name: ipython-neo4j
Version: 0.1.0
Summary: IPython/Jupyter magic commands for Neo4j Cypher queries (%cypher / %%cypher)
Project-URL: Homepage, https://github.com/neo4j-labs/ipython-neo4j
Project-URL: Repository, https://github.com/neo4j-labs/ipython-neo4j
Project-URL: Documentation, https://github.com/neo4j-labs/ipython-neo4j#readme
Project-URL: Bug Tracker, https://github.com/neo4j-labs/ipython-neo4j/issues
Author-email: Michael Hunger <github@jexp.de>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship made available under
              the License, as indicated by a copyright notice that is included in
              or attached to the work (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean, as submitted to the Licensor for inclusion
              in the Work by the copyright owner or by an individual or Legal Entity
              authorized to submit on behalf of the copyright owner. For the purposes
              of this definition, "submit" means any form of electronic, verbal, or
              written communication sent to the Licensor or its representatives,
              including but not limited to communication on electronic mailing lists,
              source code control systems, and issue tracking systems that are managed
              by, or on behalf of, the Licensor for the purpose of developing and
              improving the Work, but excluding communication that is conspicuously
              marked or designated in writing by the copyright owner as "Not a
              Contribution."
        
              "Contributor" shall mean Licensor and any Legal Entity on behalf of
              whom a Contribution has been received by the Licensor and included
              within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent contributions
              licensable by such Contributor that are necessarily infringed by
              their Contribution(s) alone or by the combination of their
              Contribution(s) with the Work to which such Contribution(s) was
              submitted. If You institute patent litigation against any entity
              (including a cross-claim or counterclaim in a lawsuit) alleging that
              the Work or any such Contribution constitutes direct or contributory
              patent infringement, then any patent licenses granted to You under
              this License for that Work shall terminate as of the date such
              litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or Derivative
                  Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, You must include a readable copy of the
                  attribution notices contained within such NOTICE file, in
                  at least one of the following places: within a NOTICE text
                  file distributed as part of the Derivative Works; within
                  the Source form or documentation, if provided along with the
                  Derivative Works; or, within a display generated by the
                  Derivative Works, if and wherever such third-party notices
                  normally appear. The contents of the NOTICE file are for
                  informational purposes only and do not modify the License.
                  You may add Your own attribution notices within Derivative
                  Works that You distribute, alongside or in addition to the
                  NOTICE text from the Work, provided that such additional
                  attribution notices cannot be construed as modifying the License.
        
              You may add Your own license statement for Your modifications and
              may provide additional grant of rights to use, copy, modify, merge,
              publish, distribute, sublicense, and/or sell copies of the
              Contribution, either on an standalone basis or as part of the Work.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or reproducing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or exemplary damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or all other
              commercial damages or losses), even if such Contributor has been
              advised of the possibility of such damages.
        
           9. Accepting Warranty or Liability. While redistributing the Work or
              Derivative Works thereof, You may choose to offer, and charge a fee
              for, acceptance of support, warranty, indemnity, or other liability
              obligations and/or rights consistent with this License. However, in
              accepting such obligations, You may offer such conditions only on
              Your own behalf and on Your sole responsibility, not on behalf of
              any other Contributor, and only if You agree to indemnify, defend,
              and hold each Contributor harmless for any liability incurred by, or
              claims asserted against, such Contributor by reason of your accepting
              any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           Copyright 2025 Neo4j, Inc.
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: cypher,database,graph,ipython,jupyter,neo4j
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: IPython
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Database
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.10
Requires-Dist: ipython>=7.0
Requires-Dist: neo4j-rust-ext>=6.0.0
Requires-Dist: neo4j-viz>=1.0.0
Requires-Dist: neo4j>=6.0.0
Requires-Dist: pandas>=1.3
Provides-Extra: dotenv
Requires-Dist: python-dotenv>=1.0; extra == 'dotenv'
Description-Content-Type: text/markdown

# ipython-neo4j

IPython / Jupyter magic commands for [Neo4j](https://neo4j.com) Cypher queries.
A modern replacement for [icypher](https://pypi.org/project/icypher/) built on the
[neo4j-rust-ext](https://pypi.org/project/neo4j-rust-ext/) Bolt driver with first-class
graph visualization via [neo4j-viz](https://neo4j.com/docs/python-graph-visualization/current/).

```python
%load_ext ipython_neo4j

%neo4j bolt://localhost:7687 -u neo4j -p secret

%cypher MATCH (m:Movie) RETURN m.title AS title, m.released AS year LIMIT 10
```

---

## Installation

```bash
pip install ipython-neo4j
```

Or with [uv](https://github.com/astral-sh/uv):

```bash
uv add ipython-neo4j
```

To use `.env` file support via `%neo4j --env-file`, install the optional extra:

```bash
pip install "ipython-neo4j[dotenv]"
```

**Requirements**: Python ≥ 3.10, Neo4j 6.x.

---

## Quick start

```python
# 1. Load the extension
%load_ext ipython_neo4j

# 2. Connect
%neo4j bolt://localhost:7687 -u neo4j -p secret

# 3. Run a read query — renders as an HTML table
%cypher MATCH (m:Movie) RETURN m.title AS title LIMIT 5

# 4. Multi-line query in a cell
%%cypher
MATCH (p:Person)-[:ACTED_IN]->(m:Movie)
RETURN p.name AS actor, count(m) AS films
ORDER BY films DESC
LIMIT 10

# 5. Get a pandas DataFrame
%%cypher --df -o df
MATCH (m:Movie) RETURN m.title AS title, m.released AS year

df.describe()

# 6. Visualize a subgraph
%%cypher --viz
MATCH (p:Person)-[r:ACTED_IN]->(m:Movie)
RETURN p, r, m
LIMIT 30
```

---

## Magic commands

### `%neo4j` — connect / status / disconnect

```
%neo4j [URI] [-u USERNAME] [-p PASSWORD] [-d DATABASE]
       [--env-file FILE]
       [--status] [--close]
```

| Flag | Description |
|---|---|
| `URI` | Bolt URI, e.g. `bolt://localhost:7687` or `neo4j+s://host` |
| `-u / --username` | Neo4j username |
| `-p / --password` | Neo4j password |
| `-d / --database` | Target database (default: `neo4j`) |
| `--env-file FILE` | Load connection settings from a `.env` file |
| `--status` | Show current connection status |
| `--close` | Close the active connection |

### `%cypher` / `%%cypher` — read queries

```
%cypher [flags] QUERY
%%cypher [flags]
<query body>
```

### `%wcypher` / `%%wcypher` — write queries

Identical to `%cypher` / `%%cypher` but **write and schema operations are explicitly allowed**.
Use this to make write intent visible in notebooks.

### Common flags for `%cypher` / `%%cypher` / `%wcypher` / `%%wcypher`

| Flag | Description |
|---|---|
| `--write / -w` | Allow write / schema queries (alternative to `%%wcypher`) |
| `--no-preflight` | Skip the `EXPLAIN` query-type pre-flight check |
| `-o VAR` | Store the `CypherResult` in the notebook variable `VAR` |
| `--df` | Return / store a pandas `DataFrame` instead of a `CypherResult` |
| `--viz` | Render an interactive graph visualization (requires `neo4j-viz`) |
| `-P EXPR` | Query parameters — a Python expression evaluated in the notebook namespace |
| `-u / --uri` | Override connection URI for this query only |
| `--username` | Override username for this query only |
| `-p / --password` | Override password for this query only |
| `-d / --database` | Override database for this query only |

---

## Configuring the connection

Connection settings are resolved in this priority order (highest wins):

```
explicit flag on %neo4j  >  --env-file values  >  shell env vars  >  built-in defaults
```

### Option 1 — Direct flags (most explicit)

```python
%neo4j bolt://localhost:7687 -u neo4j -p secret -d mydb
```

### Option 2 — `.env` file

Create a `.env` file (and add it to `.gitignore`):

```ini
NEO4J_URI=bolt://localhost:7687
NEO4J_USERNAME=neo4j
NEO4J_PASSWORD=secret
NEO4J_DATABASE=mydb
```

Then in your notebook:

```python
%neo4j --env-file .env
%neo4j --env-file secrets.env -d override_db   # file + per-flag override
```

Requires [`python-dotenv`](https://pypi.org/project/python-dotenv/):
```bash
pip install python-dotenv
```

### Option 3 — IPython `%env` magic (no file needed)

```python
%env NEO4J_URI=bolt://localhost:7687
%env NEO4J_USERNAME=neo4j
%env NEO4J_PASSWORD=secret
%env NEO4J_DATABASE=mydb
%neo4j   # picks up the vars automatically
```

### Option 4 — Shell environment variables

Set variables before launching Jupyter, then call `%neo4j` with no arguments:

```bash
export NEO4J_URI=bolt://localhost:7687
export NEO4J_USERNAME=neo4j
export NEO4J_PASSWORD=secret
export NEO4J_DATABASE=mydb
jupyter lab
```

```python
%neo4j   # auto-connects from env
```

### Option 5 — `python-dotenv` directly in a cell

```python
from dotenv import load_dotenv
load_dotenv(".env")   # populates os.environ
%neo4j                # reads from env
```

### Option 6 — Per-query connection override

Override the global connection for a single query without changing it:

```python
%%cypher -u bolt://other-host:7687 --username analyst -p readonly -d reporting
MATCH (n:Report) RETURN n LIMIT 5
```

---

## Read / write safety

`%cypher` (and `%%cypher`) **block write and schema queries by default**.
Before executing, an `EXPLAIN` pre-flight call is made to detect the query type:

| Neo4j type | Meaning | Default behaviour |
|---|---|---|
| `r` | Read | ✅ Allowed |
| `w` | Write | ❌ Blocked |
| `rw` | Read + write | ❌ Blocked |
| `s` | Schema (DDL) | ❌ Blocked |

To allow writes, use `--write` or the dedicated `%%wcypher` magic:

```python
# Either of these works:
%%cypher --write
CREATE (n:Person {name: 'Alice'}) RETURN n

%%wcypher
CREATE INDEX person_name IF NOT EXISTS FOR (n:Person) ON (n.name)
```

Skip the pre-flight check when you know the query is safe (e.g. on slow connections):

```python
%%cypher --no-preflight
MATCH (n) RETURN n LIMIT 100
```

---

## Multi-statement cells

Statements can be separated by a **semicolon at the end of a line** — the same convention
used in Cypher Shell and Neo4j Browser:

```python
%%wcypher
CREATE INDEX person_name IF NOT EXISTS FOR (n:Person) ON (n.name);
CREATE CONSTRAINT person_id IF NOT EXISTS FOR (n:Person) REQUIRE n.id IS UNIQUE
```

Each statement is EXPLAIN'd individually. If **any** statement is a write or schema
operation the entire cell is blocked unless `--write` / `%%wcypher` is used.

> **Note:** Mid-line semicolons — e.g. inside string literals like
> `WHERE name = 'O;Brien'` — are **not** treated as statement separators.

When multiple statements are present, each result is displayed with a numbered header
and the **last result** is stored when `-o VAR` is used.

---

## Working with results

```python
%%cypher -o result
MATCH (p:Person)-[:ACTED_IN]->(m:Movie)
RETURN p.name AS name, m.title AS title
LIMIT 20
```

```python
# CypherResult renders as an HTML table in Jupyter automatically

result           # display HTML table
result.df        # pandas DataFrame shorthand
result.to_dataframe()   # same

len(result)      # number of rows
result.keys      # column names
result.counters  # write counters (nodes_created, etc.)
result.summary   # full Neo4j ResultSummary

result.visualize()               # render neo4j-viz graph
result.visualize(color_by="caption")   # with custom coloring
result.to_graph()                # VisualizationGraph object
```

### Query parameters

Pass a Python expression (evaluated in the notebook namespace) with `-P`:

```python
params = {"year": 2000, "name": "Tom Hanks"}

%%cypher -P params -o movies
MATCH (p:Person {name: $name})-[:ACTED_IN]->(m:Movie)
WHERE m.released >= $year
RETURN m.title AS title, m.released AS year
```

---

## Graph visualization

Return `Node` and `Relationship` objects and render them with `--viz`:

```python
%%cypher --viz
MATCH (p:Person)-[r:ACTED_IN]->(m:Movie)
RETURN p, r, m
LIMIT 40
```

Or call `.visualize()` programmatically on any `CypherResult`:

```python
%%cypher -o g
MATCH (p:Person)-[r:DIRECTED]->(m:Movie) RETURN p, r, m LIMIT 20

g.visualize(color_by="caption")
```

Visualization is powered by [neo4j-viz](https://neo4j.com/docs/python-graph-visualization/current/)
and is installed automatically as a dependency.

---

## Error rendering

Neo4j errors (syntax errors, type errors, auth failures, connectivity issues) are
rendered as styled HTML in the cell output rather than raw Python tracebacks:

```python
%cypher MATCH (n) RETURN @@bad@@
# → Cypher Syntax Error: rendered with error code and query context
```

---

## Reloading after code changes

When developing `ipython-neo4j` itself, reload the extension without restarting the kernel:

```python
%reload_ext ipython_neo4j
```

---

## Development

```bash
git clone https://github.com/neo4j-labs/ipython-neo4j
cd ipython-neo4j
uv sync --all-groups

# unit tests (no Neo4j required)
uv run pytest tests/test_connection.py tests/test_result.py tests/test_magic.py -v

# integration tests (requires Neo4j)
# credentials in integration.env
uv run pytest tests/test_integration.py -v

# run the demo notebook
uv run jupyter lab notebooks/demo.ipynb
```

Integration tests use:
- **Read-only demo** (`integration.env` default): `neo4j+s://demo.neo4jlabs.com` — user/db: `movies`
- **Local write tests**: `bolt://localhost:7687` — user: `neo4j`, password: `password`

---

## License

Apache 2.0
