Skip to content
Snippets Groups Projects
Commit 4c21fc8f authored by Alex Kanitz's avatar Alex Kanitz
Browse files

Update labkey_api.md

parent fbb46f38
No related branches found
No related tags found
1 merge request!8Labkey api
Pipeline #10072 passed
This commit is part of merge request !8. Comments created here will be created in the context of that merge request.
> **NOTE**: Include this info in the main doc in the root directory once available
> **NOTE**: Include this info in the main doc in the root directory once
> available; add information on how to get credentials for the LabKey server
> (i.e., how to obatain a password for the `.netrc` file)
In order to connect to the LabKey through API, you will first need to create a file `.netrc` in your
home directory:
In order to connect to the LabKey through API, you will first need to create a
file `.netrc` in your home directory:
```bash
touch ${HOME}/.netrc
......@@ -15,13 +17,15 @@ login <user-email>
password <user-password>
```
To secure the file, set permissions in a way that only you can see the content of the file:
To secure the file, set permissions in a way that only you can see the content
of the file:
```bash
chmod 400 .netrc
```
Install the `labkey` and `pandas` packages, ideally from a virtual environment (e.g., `virtualenv` or `conda`):
Install the `labkey` and `pandas` packages, ideally from a virtual environment
(e.g., `virtualenv` or `conda`):
```bash
pip install labkey pandas
......@@ -39,5 +43,7 @@ Example:
python labkey_api.py TEST_ABOERSCH RNA_Seq_data_template
```
Right now the script prints a representation of a `pandas` data frame containing the requested LabKey table the the screen.
For further processing the current script could be included in another script, or it could be modified to write out the data in a desired file format (e.g., TSV).
Right now the script prints a representation of a `pandas` data frame
containing the requested LabKey table the the screen. For further processing
the current script could be included in another script, or it could be modified
to write out the data in a desired file format (e.g., TSV).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment