Skip to content

Commit

Permalink
fix(packaging): adding config data to package
Browse files Browse the repository at this point in the history
  • Loading branch information
Lluis Santos committed Nov 13, 2020
1 parent 43b82f1 commit 93fb060
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 28 deletions.
37 changes: 11 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,46 +7,31 @@ This file shows the basic usage for TradingKit, for more docs, please see the [W

## Requirements
- python 3.7+
- python virtual environment (venv)
- pip

## Installation
the recommended (and unique supported way) to install TradingKit si via **pip**.
the recommended way to install TradingKit si via **PyPi**.

### Instructions for unix
### Install from [PyPi](https://pypi.org/project/tradingkit/)
```bash
# clone repo
git clone git@github.com:logictraders/tradingkit.git
cd tradingkit

# create and activate virtual environment (venv)
python -m venv venv
source venv/bin/activate

# install the package for development
pip install -e .
pip3 install tradingkit
```

### Instructions for windows
### Install from [Source](https://github.com/logictraders/tradingkit)
```bash
# TODO...
git clone https://github.com/logictraders/tradingkit
cd tradingkit
# Optional, uncomment the line below if you want a specific version
# git checkout v1.1.5
python3 setup.py install
```

## Creating strategies
In order to create new strategies you need **5 steps**
In order to create new strategies you need **4 steps**

### Create separate project
Create new python3.7+ project, no need to do anymore in this step.

### Install virtualenv and dependencies
To do this step need to install previously TradingKit with the installation steps described above.
```bash
cd my_project
python -m venv venv
source venv/bin/activate
pip install ccxt
pip install -e ../tradingkit
```

### Creating strategy class
create a class extending from `tradingkit.strategy.strategy.Strategy`
```python
Expand Down
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setuptools.setup(
name="tradingkit",
version="1.1.5",
version="1.1.6",
author="QBit Artifacts, SL",
author_email="lluis@logictraders.com",
license="Propietary",
Expand All @@ -11,7 +11,8 @@
long_description_content_type="text/markdown",
url="https://github.com/logictraders/tradingkit",
packages=setuptools.find_namespace_packages(where="src", include=['tradingkit.*']),
package_dir={"": "src"},
package_dir={"tradingkit": "src"},
package_data={"tradingkit": ["src/config"]},
entry_points={
"console_scripts": [
"tk = tradingkit.cli.cli:CLI.main"
Expand Down

0 comments on commit 93fb060

Please sign in to comment.