Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ieuans authored Jun 18, 2024
1 parent 011b0c8 commit 9fb2115
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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/)
Expand Down Expand Up @@ -183,4 +189,4 @@ datasource_list = client.datasources.get()

# Get the datasource detail
datasource_detail = client.datasources.get_detail(1)
```
```

0 comments on commit 9fb2115

Please sign in to comment.