Skip to content

Update README file with SDK installation instruction #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,39 @@ Docs related to this repository are located at:
4. GatewayResponse Error / Decline Codes: https://help.rocketgate.com/support/solutions/articles/28000018169-gatewayresponse-error-decline-codes


## Installation Steps

### 1. Create the RocketGate Package
At the root of your project, create a directory named `RocketGate`. This will serve as the Python package for the RocketGate SDK.

### 2. Add the SDK File
Copy the `RocketGate.py` file into the newly created `RocketGate` directory.

### 3. Initialize the Package
In the `RocketGate` directory, create a file named `__init__.py` with the following content:
```python
from .RocketGate import *
```

### 4. Import and Use the SDK
Now, you can import the RocketGate package in your Python files and use the SDK as follows:
```python
from RocketGate import *

# Sample Usage:

# Create instances of request, response, and service
request = GatewayRequest()
response = GatewayResponse()
service = GatewayService()

# Set the required merchant credentials
request.Set(GatewayRequest.MERCHANT_ID, 1)
request.Set(GatewayRequest.MERCHANT_PASSWORD, "testpassword")

# Add more implementation as needed
```

## Running integration tests
From the root of the project, using your installed Python Interpreter, run the following command:
```shell
Expand Down