Configuration ๐Ÿ› ๏ธ ยถ

config.csv ยถ

Configuring config.csv is a mandatory step to make GreedyBoy able to work on its own.

config.csv is formattedโ€ฆ. like a csv file.

Table representation ๐Ÿ‘จโ€๐Ÿซ ยถ

apiKey

apiPrivateKey

githubToken

repoName

dataBranchName

Api_Key

Api_Private_Key

Github_Token

kevinpruvost/GreedyBoy ( for instance )

data ( for instance )

File representation ๐Ÿ“ ยถ

apiKey,apiPrivateKey,githubToken,repoName,dataBranchName
`Api_Key`,`Api_Private_Key`,`Github_Token`,kevinpruvost/GreedyBoy,data

How to get these informations ๐Ÿ—ƒ๏ธ ยถ

Warning

Get yourself a Kraken account because GreedyBoy canโ€™t work without it.

And also if you donโ€™t have a Github account, create one.

In case you didnโ€™t have a Github account, then youโ€™ll be considered sussy from now on.

apiKey & apiPrivateKey ยถ

  1. Go on Kraken Overview and click on your Name, Security and API

_images/screenshot1.png
  1. Click on Add key

_images/screenshot2.png

3. For the permissions, pick Query Funds, Query Open Orders & Trades, Query Closed Orders & Trades , Create & Modify Orders, Cancel/Close Orders and Access Websockets API

_images/screenshot3.png
  1. Then you can finally access your API Key and API Private Key

_images/screenshot4.png

githubToken ยถ

  1. Go in here and click on Generate new token

_images/screenshot11.png
  1. Type in Note any name you want, just not something too sussy. Then check repo for the scopes

_images/screenshot21.png
  1. Then go down the page and click on Generate token

_images/screenshot31.png
  1. Then itโ€™s good to go, you got your Github Token !

_images/screenshot41.png

repoName ยถ

  1. Go on github.com and create a New repository.

_images/screenshot12.png
  1. Configure & Create your repository.

_images/screenshot22.png
  1. You can now get repoName in these 2 fields.

_images/screenshot32.png

dataBranchName ยถ

Warning

For this last step, you will need Github Dekstop or whatever form of Git you are using ( Git Bash , git (package from Linux) , โ€ฆ)

Github Desktop ๐Ÿ’ป ยถ
  1. Clone the repository wherever you want

_images/screenshot42.png

2. If you want to make GreedyBoy use the main branch of your repository you cant stop there and just take main as your `dataBranchName

However, if you want to make another branch, then click on Current branch , type in the new branch name and click on Create new branch .

_images/screenshot5.png
  1. Click on Publish branch and get your new branch name as dataBranchName

_images/screenshot6.png
Git Command ๐Ÿ‘จโ€๐Ÿ’ป ยถ
  1. So if you want to go with brute force, go on whatever shell you wanna use.

cd into the directory you want to clone your repository to.

Then launch this command git clone $REPO_SSH_LINK|$REPO_HTTP_LINK .

_images/screenshot7.png
  1. cd into your repository, git branch $BRANCH_NAME , and git push -u origin $BRANCH_NAME .

_images/screenshot8.png
  1. Youโ€™re good to go, take $BRANCH_NAME as your dataBranchName .