Skip to content
This repository was archived by the owner on Jan 21, 2026. It is now read-only.

add rudimentary client config to README #6

Open
ixcat wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add rudimentary client config to README #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ This is an official DataJoint Python plugin for connection to DJNeuro's hosted i

Note: This plugin adds features to the `datajoint` package and thus requires it. Users should not import directly from the plugin but instead simply `import datajoint` to access plugin features.

## Client Usage

The plugin enables connections to hosted instances by adding support
for a 'hub:' URL scheme to look up database hosts. To configure, simply
install datajoint, the plugin, and set the host URL accordingly. From
here, the plugin will intercept hosts specified using the 'hub://'
URL scheme and connect to the corresponding database.

```
$ pip install datajoint
$ pip install datajoint-connection-hub
$ export DJ_HOST=hub://djhub.io/<orgname>/<pipeline-name>
```


## Run tests locally

```
Expand All @@ -15,4 +30,4 @@ $$ exit
$ ./serve.sh down LOCAL
```

Note: Make sure to have a valid Git SSH key to access necessary private repos.
Note: Make sure to have a valid Git SSH key to access necessary private repos.