Skip to content

Commit

Permalink
Update gafferpy links (#418)
Browse files Browse the repository at this point in the history
  • Loading branch information
t92549 authored Oct 16, 2023
1 parent 3e170d7 commit cdfeb99
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 14 deletions.
12 changes: 3 additions & 9 deletions docs/development-guide/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,12 @@ Organization](https://github.com/orgs/gchq/repositories).

## Repositories

The [Gaffer core repo](https://github.com/gchq/Gaffer) contains the main Gaffer product.
The core Java [Gaffer repo](https://github.com/gchq/Gaffer) contains the main Gaffer product.
If you are completely new to Gaffer you can try out our [Road Traffic Demo](https://github.com/gchq/Gaffer/blob/master/example/road-traffic/README.md) or look at our example [deployment guide](../development-guide/example-deployment/project-setup.md).

The [gaffer-tools repo](https://github.com/gchq/gaffer-tools) contains a number of useful tools that assist in working with Gaffer.
These include:
The [gafferpy repo](https://github.com/gchq/gafferpy) contains a python shell that can execute operations.

- `gafferpy` - Allows operations against a graph to be executed from a Python shell
- `mini-accumulo-cluster` - Allows a mini Accumulo cluster to be spun up for testing purposes
- `performance-testing` - Methods of testing the performance of ingest and query operations against a graph
- `random-element-generation` - Code to generate large volumes of random graph data

The [Gaffer docker repo](https://github.com/gchq/gaffer-docker) contains the code needed to run Gaffer using Docker or Kubernetes.
The [gaffer-docker repo](https://github.com/gchq/gaffer-docker) contains the code needed to run Gaffer using Docker or Kubernetes.
More information about running a containerised instance of Gaffer can be found in our [adminstration guide](../administration-guide/introduction.md).

It is also worth noting the [koryphe repo](https://github.com/gchq/koryphe) as this is a key dependency for Gaffer.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/operations-guide/accumulo.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ This operation has been introduced as a replacement to the `GetElementsBetweenSe

!!! warning "Currently Unavailable"

The python API for this operation is currently unavailable [see this issue](https://github.com/gchq/gaffer-tools/issues/1082).
The python API for this operation is currently unavailable [see this issue](https://github.com/gchq/gafferpy/issues/14).

Results:

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/apis/python-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ able to access almost any features or end points available in the main rest API.
## Installation

Currently there isn't a release of `gafferpy` on pypi or other pip repository;
however, the source code can still be cloned from the [git repository](https://github.com/gchq/gaffer-tools/tree/develop/python-shell)
however, the source code can still be cloned from the [git repository](https://github.com/gchq/gafferpy/tree/main)
and installed via pip. Please see the readme in the `gafferpy` repository for
full instructions.

Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/gaffer-basics/what-is-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ Python is a popular high level programming language that's seen massive populari

## Python in Gaffer

Whilst Gaffer is written primarily in Java a Python interface has been provided so that you can programmatically access Gaffer functionality with Python, this can be accessed via the gafferpy library located in the [gaffer-tools repository](https://github.com/gchq/gaffer-tools).
Whilst Gaffer is written primarily in Java a Python interface has been provided so that you can programmatically access Gaffer functionality with Python, this can be accessed via the gafferpy library located in the [gafferpy repository](https://github.com/gchq/gafferpy).
This provides a Python 3.6+ compatible import that will allow you to speak directly to the Gaffer REST API, it supports persistent connections to Gaffer, connection via SSL and the associated Python functionality to interact with available Gaffer operations.

!!! note
See the page on [using the Python API](../apis/python-api.md) in gaffer for further information.

Inside the gaffer-tools library you'll find a set of examples that show how you can interact with Gaffer, here is a basic example of using gafferpy:
Inside the gafferpy library you'll find a set of examples that show how you can interact with Gaffer, here is a basic example of using gafferpy:

!!! example ""
This executes a get request into Gaffer to retrieve the current schema.
Expand Down Expand Up @@ -40,4 +40,4 @@ In this simple example you can see the use of a `gaffer_connector`; the purpose
The main `gaffer` Python module (usually imported as `g`) allows access to various functions to run Gaffer operations. This connection works by serialising the Python code into JSON and then transferring this to be deserialised and ran in Gaffer.

!!! tip
A link to the gaffer tools repository can be found here: [GCHQ/gaffer-tools](https://github.com/gchq/gaffer-tools)
A link to the gafferpy repository can be found here: [gchq/gafferpy](https://github.com/gchq/gafferpy)

0 comments on commit cdfeb99

Please sign in to comment.