Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/antora/modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
* xref:index.adoc[]
* xref:installation.adoc[]
* xref:getting-started.adoc[]
* xref:integration.adoc[]
* xref:rendering.adoc[]
* xref:customizing.adoc[]
* xref:integration/index.adoc[]
** xref:integration/gds.adoc[]
** xref:integration/neo4j.adoc[]
** xref:integration/snowflake.adoc[]
** xref:integration/gql.adoc[]
** xref:integration/pandas.adoc[]
* link:{tutorials-docs-uri}[Tutorials]
* link:{api-docs-uri}[API reference]
2 changes: 1 addition & 1 deletion docs/antora/modules/ROOT/pages/customizing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you have not yet created a `VisualizationGraph` object, refer to one of the f
* xref:getting-started.adoc[Getting started] for creating a visualization graph from scratch using `neo4j-viz`
primitives like link:{api-docs-uri}/node/[Node] and link:{api-docs-uri}/relationship/[Relationship] and
link:{api-docs-uri}/visualization-graph[`VisualizationGraph`] directly.
* xref:integration.adoc[] for importing data from a Pandas DataFrame or Neo4j GDS projection.
* xref:integration/index.adoc[] for importing data from a Pandas DataFrame or Neo4j GDS projection.

== Setting node captions

Expand Down
2 changes: 1 addition & 1 deletion docs/antora/modules/ROOT/pages/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,6 @@ Now that we have covered the basics of creating and rendering a visualization gr
Here are some suggestions for what to do next:

* Browse the link:{tutorials-docs-uri}[notebook examples] for more examples and use cases
* Learn about the xref:integration.adoc[integrations] with other libraries such as Neo4j GDS and Pandas
* Learn about the xref:integration/index.adoc[integrations] with other libraries such as Neo4j GDS and Pandas
* Check out the xref:rendering.adoc[rendering options] and convenience methods of `VisualizationGraph`
* Read about our link:{api-docs-uri}/[API reference]
11 changes: 7 additions & 4 deletions docs/antora/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
= Introduction

This is the documentation for the `neo4j-viz` Python library by Neo4j.
The library allows you to visualize graph data interactively in Python using a simple API.
The Python Graph Visualization library allows you to visualize graph data interactively in Python.

The library wraps the link:https://neo4j.com/docs/nvl/current/[Neo4j Visualization JavaScript library (NVL)], and provides additional features for working with graph data in Python.
Notably, there are convenience methods for importing data from source such as link:https://pandas.pydata.org/[Pandas DataFrames], link:https://neo4j.com/docs/graph-data-science/current/[Neo4j Graph Data Science], link:https://neo4j.com/docs/python-manual/current/[Neo4j Database], and link:https://docs.snowflake.com/[Snowflake tables].
The library wraps the JavaScript-based link:https://neo4j.com/docs/nvl/current/[Neo4j Visualization Library (NVL)] and adds convenience methods to import data from sources such as:

* xref:integration/pandas.adoc[]
* xref:integration/gds.adoc[]
* xref:integration/neo4j.adoc[]
* xref:integration/snowflake.adoc[]

The source code is available on link:https://github.com/neo4j/python-graph-visualization[GitHub].
If you have a suggestion on how we can improve the library or want to report a problem, you can create a link:https://github.com/neo4j/python-graph-visualization/issues/new[new issue].
43 changes: 6 additions & 37 deletions docs/antora/modules/ROOT/pages/installation.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Installation

To install the latest version of the library, run:
You can install the latest version of the library with `pip`:

[source, console]
----
Expand All @@ -9,47 +9,16 @@ pip install neo4j-viz

== Optional dependencies

In addition, there are a few optional dependencies that you can install to enable additional features of the library.
There are a few optional dependencies that you can install to enable additional features of the library.

=== Pandas DataFrames `from_dfs` importer
=== Integration with external sources

To install the additional dependencies required for the link:{api-docs-uri}/from_pandas[`from_dfs`] importer you can run:

[source, console]
----
pip install neo4j-viz[pandas]
----

=== Neo4j `from_neo4j` importer

To install the additional dependencies required for the link:{api-docs-uri}/from_neo4j[`from_neo4j`] importer you can run:

[source, console]
----
pip install neo4j-viz[neo4j]
----

=== Neo4j Graph Data Science `from_gds` importer

To install the additional dependencies required for the link:{api-docs-uri}/from_gds[`from_gds`] importer you can run:

[source, console]
----
pip install neo4j-viz[gds]
----

=== Neo4j Graph Data Science `from_snowflake` importer

To install the additional dependencies required for the link:{api-docs-uri}/from_snowflake[`from_snowflake`] importer you can run:

[source, console]
----
pip install neo4j-viz[snowflake]
----
The library can import data directly from xref:integration/index.adoc[external sources].
Each integration page includes installation instructions for the needed dependencies.

=== Notebook tutorials

To install all the additional dependencies required for the link:{tutorials-docs-uri}[notebook examples] you can run:
You need to install some additional dependencies to run the link:{tutorials-docs-uri}[Jupyter notebook tutorials]:

[source, console]
----
Expand Down
Loading