Skip to content
Snippets Groups Projects
Commit 6935c2ba authored by Ankit Izardar's avatar Ankit Izardar
Browse files

update readme

parent 00e68bb8
No related branches found
No related tags found
No related merge requests found
......@@ -2,28 +2,41 @@
This repository contains Python scripts that perform various tasks using the LabKey Python API. These scripts help interact with LabKey Server for data retrieval, updates, and management tasks.
## Prerequisites
Ensure you have the following installed before using these scripts:
## Requirements
- Python 3.x
- `labkey` package (Install using `pip install --upgrade labkey`)
- `
- `labkey` Python package
- `.netrc` file for authentication (https://www.labkey.org/Documentation/wiki-page.view?name=netrc)
## API Wrapper
## Scripts Overview
### 1. Create_Project.py
- Creates a new project in LabKey.
- Takes a **project name** as a command-line argument.
- If the project already exists, it notifies the user.
## Authentication
**Usage:**
```bash
python Create_Project.py <project_name>
```
## Scripts Overview
### 2. Create_Project_and_subfolder.py
- Creates a project and a **Sample Manager** type subfolder in LabKey.
- Takes both a **project name** and a **subfolder name** as arguments.
### `Create_project.py`
Creates a project folder on the home page.
Usage:
```sh
python Create_project.py "project_name"
**Usage:**
```bash
python Create_Project_and_subfolder.py <project_name> <subfolder_name>
```
### 3. Get_projects_list.py
- Connects to the LabKey server using credentials stored in a `.netrc` file.
- Retrieves a list of projects and folders.
**Usage:**
```bash
python Get_projects_list.py
```
## Contributing
Feel free to submit pull requests for enhancements or bug fixes. Ensure that your code follows best practices and includes comments where necessary.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment