-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,11 +7,17 @@ The Concept Library is a system for storing, managing, sharing, and documenting | |
https://swanseauniversitymedical.github.io/pyconceptlibraryclient/ | ||
|
||
## Installation | ||
This package can be easily installed using pip. In your terminal, run the following command: | ||
This package can be installed using pip. In your terminal, run the following command: | ||
``` | ||
pip install git+https://github.com/SwanseaUniversityMedical/[email protected] | ||
``` | ||
|
||
### Inside the SAIL gateway / offline install | ||
|
||
SAIL users or users requiring offline installation of the package can: | ||
1. Download the [latest release](https://github.com/SwanseaUniversityMedical/pyconceptlibraryclient/releases) | ||
2. Install the package using pip, e.g. `pip install /path/to/file/pyconceptlibraryclient-1.0.1.tar.gz` | ||
|
||
# Using the package | ||
The package provides a function to connect to the Concept Library API and multiple functions to send requests to the API's endpoints. | ||
|
||
|
@@ -56,7 +62,7 @@ client = Client( | |
## Gateway (conceptlibrary.serp.ac.uk/) | ||
client = Client( | ||
public=True, | ||
url=DOMAINS.DEMO | ||
url=DOMAINS.GATEWAY | ||
) | ||
|
||
## Demo site (conceptlibrary.demo-dev.saildatabank.com/) | ||
|
@@ -183,4 +189,4 @@ datasource_list = client.datasources.get() | |
|
||
# Get the datasource detail | ||
datasource_detail = client.datasources.get_detail(1) | ||
``` | ||
``` |