Skip to content

Commit 8eae1b3

Browse files
authored
Filed out README.md
1 parent 00f432b commit 8eae1b3

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
11
# StockDistributor
2-
A Python app for baying stocks on XTB for a specific amount of money
2+
A cmd Python app for baying stocks on XTB for a specific amount of money
3+
4+
# Install
5+
To install you are going to need python and some libraries
6+
7+
* websocket-client==1.4.1
8+
* termtables
9+
* pytz
10+
* decimal
11+
12+
if you heave pip you can run imports.bat to install them all at once
13+
14+
get python here:
15+
https://www.python.org/downloads/
16+
17+
and pip here:
18+
https://pypi.org/project/pip/
19+
# How to use
20+
Lunch the app.py in your cmd and follow the instructions.
21+
# Features
22+
In this app, you can log in to your XTB account via the API and select a certain amount of balance to be distributed between stocks of your choosing and parachuted with minimal amount not spend.
23+
24+
* you can save several accounts in the accounts.json file, so you don't heave to type out the ID every time (format: [Lp, ID, demo/real, note]).
25+
* You can import .json files with stocks to sped up your operation (check out exp_Indexes.json).
26+
* If an exchange is closed, the app can wait until its opening.
27+
# Disclaimer
28+
Read the code at your own risk!
29+
30+
This is the first code I have ever written, so it is horrendous, but hey it does the job.
31+
32+
If you can bare it, feel free to contribute!
33+
34+
# Credits
35+
Big thanks to Saitama298 on GitHub for making the API.py part of this app, I would not be able to do this without it,
36+
37+
but you still heave to use the version from this repository because I modified the original code.

0 commit comments

Comments
 (0)