Metadata-Version: 2.3
Name: RedcapLite
Version: 1.0.0
Summary: A Lightweight Python Client for REDCap
Project-URL: Homepage, https://github.com/jubilee2/RedcapLite
Project-URL: Issues, https://github.com/jubilee2/RedcapLite/issues
Author-email: Jubilee Tan <jubilee2@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# RedcapLite

`RedcapLite` is a Python package for interacting with the REDCap API. This package provides methods to interact with different API endpoints in a straightforward way.

## Installation

To install the package, clone the repository and install it using `pip`:

```sh
git clone https://github.com/jubilee2/RedcapLite.git
cd RedcapLite
pip install .
```

## Usage

### Importing the Package

To use the `RedcapLite` package, import it in your Python script:

```python
import RedcapLite
```

### Creating an Instance

Create an instance of the `RedcapClient` class by providing the API URL and token:

```python
r = RedcapLite.RedcapClient('https://redcap.vumc.org/api/', 'your_token')
```

### Methods

#### `get_arms()`

Retrieve the list of arms from the REDCap API.

```python
arms = r.get_arms()
print(arms)
```

#### `delete_arms(arms)`

Delete the specified arms. Provide a list of arm IDs to delete.

```python
r.delete_arms(arms=[3])
```

### Example

Here’s a complete example of how to use the `RedcapLite` package:

```python
import RedcapLite

# Create an instance of RedcapClient
r = RedcapLite.RedcapClient('https://redcap.vumc.org/api/', 'your_token')

# Get arms
arms = r.get_arms()
print("Arms:", arms)

# Delete specific arms
r.delete_arms(arms=[3])
print("Arm 3 deleted successfully.")
```

### Contributing

If you would like to contribute to the project, please fork the repository, make your changes, and submit a pull request.

### License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
