Metadata-Version: 2.1
Name: alpaca-lumnis-trader
Version: 0.0.8
Summary: Lumnis Alternative Data
Home-page: https://github.com/lumnisfactors/AlpacaLumnisTrader/archive/refs/tags/0.0.8.tar.gz
Author: Abubakarr Jaye
Author-email: contact@lumnis.io
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# AlpacaLumnisTrader


## API Usage 

### Install the package 
pip3 install alpaca-lumnis-trader --upgrade

### Overriding the run function

### Overriding the main function

## Development Usage

### Fork the repo
Go to the follwing link to fork the repository:

``` 
https://github.com/lumnisfactors/AlpacaLumnisTrader.git 
```

### Clone the Repo

Use the following command to clone the repository:

```
git clone https://github.com/[YOUR_USERNAME]/AlpacaLumnisTrader.git
```

### Install Requirements

After cloning the repository, navigate to the project's root directory and install the required packages using the following command:

```
pip install -r requirements.txt
```

### Add API Keys

Create a new file in the AlpacaLumnisTrader directory and name it KEYS.py. Add the following variables to the file and replace the empty strings with your respective API keys:

```

API_KEY_ALPACA = "YOUR_ALPACA_API_KEY"
SECRET_KEY_ALPACA = "YOUR_ALPACA_SECRET_KEY"
API_KEY_LUMNIS = "YOUR_LUMNIS_API_KEY"
```

These API keys are required for using Binance and Luminis data to make trades. Please ensure that you keep your API keys secret and never share them with anyone.
