r2r/sdk/README.md

R2R Python SDK Documentation

For the complete look at the R2R Python SDK, visit our documentation.

Installation

Before starting, make sure you have completed the R2R installation.

Install the R2R Python SDK:

pip install r2r

Getting Started

1. Import the R2R client:

from r2r import R2RClient

1. Initialize the client:

client = R2RClient("http://localhost:7272")

1. Check if R2R is running correctly:

health_response = client.health()
# {"status":"ok"}

1. Login (Optional):

   client.register("me@email.com", "my_password")
   # client.verify_email("me@email.com", "my_verification_code")
   client.login("me@email.com", "my_password")
   

   When using authentication the commands below automatically restrict the scope to a user's available documents.