Skip to content

Commit cdc8c52

Browse files
author
investing-algorithms
authored
Merge pull request #21 from investing-algorithms/hotfix_install
Update install
2 parents a8cf892 + b850dad commit cdc8c52

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

INSTALL.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Installation
2+
3+
4+
### Install Python
5+
Being a Python framework, it requires Python. Python includes a lightweight database called
6+
SQLite that the framework can use so you won’t need to set up a database just yet.
7+
8+
As of now, the framework only works with python 3.x.
9+
10+
### Python pip install (recommended)
11+
12+
You can easily use pip to install the framework in your python environment.
13+
14+
```sh
15+
$ pip install investing-algorithm-framework
16+
```
17+
18+
### Installation from source
19+
20+
First clone the repository
21+
```sh
22+
$ git clone https://github.com/investing-algorithms/investing-algorithm-framework.git
23+
```
24+
25+
Then install the framework by running:
26+
```sh
27+
$ pip install <path to cloned investing-algorithm-framework>
28+
```
29+
30+
### Verifying the installation
31+
32+
To verify that you correctly installed the framework, type python from your shell. Then at the Python prompt,
33+
try to import investing-algorithm-framework:
34+
35+
```python
36+
import investing-algorithm-framework
37+
print(investing-algorithm-framework.get_version())
38+
```
39+

0 commit comments

Comments
 (0)