make pypi package

alm0ra · Jan 9, 2022 · 14fb6e2 · 14fb6e2
1 parent 113502b
commit 14fb6e2
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -12,11 +12,21 @@
 a library for demo trading | backtest and forward test simulation
 
 ## Features
-
-# Requirements
-
+- [x] **Limit/Market orders**: you can place a Limit or Market order in 2 side "long", "Short" .
+- [x] **SL/TP set**: you can set stop loss and take profit for your market or limit order .
+# Documentations
+    ..
 # Getting start
-
+install package using PyPI
+```bash
+pip install trade-engine
+```
+### import package 
+```bash
+from trade_engine import TradeEngine
+engine = TradeEngine()
+
+```
 # Contributing
 Contributions are very welcome. There are a number of requirements:
 * See Issues tab, and feel free to submit your own issues

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
diff --git a/setup.py b/setup.py
@@ -0,0 +1,29 @@
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="trade_engine",
+    version="1.1.4",
+    author="Ali moradi",
+    author_email="ali.mrd318@gmail.com",
+    description="a small package for simulate trading",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/xibalbas/trade-engine",
+    project_urls={
+        "Bug Tracker": "https://github.com/xibalbas/trade-engine/issues",
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    package_dir={"": "src"},
+    packages=setuptools.find_packages(where="src"),
+    install_requires = [
+        'pandas'
+        ],
+    python_requires=">=3.7",
+)
diff --git a/src/__init__.py b/src/__init__.py
diff --git a/src/trade_engine/__init__.py b/src/trade_engine/__init__.py
@@ -0,0 +1 @@
+from .trade_engine import TradeEngine
diff --git a/src/operations.py → src/trade_engine/operations.py b/src/operations.py → src/trade_engine/operations.py
@@ -1,4 +1,5 @@
 class EngineOperation:
+
     """Engine Operations
     All operations realted to TradeEngine class wrote here
     """

diff --git a/src/requirements.txt → src/trade_engine/requirements.txt b/src/requirements.txt → src/trade_engine/requirements.txt
diff --git a/src/engine.py → src/trade_engine/trade_engine.py b/src/engine.py → src/trade_engine/trade_engine.py
@@ -1,5 +1,5 @@
 import pandas as pd
-from operations import EngineOperation
+from .operations import EngineOperation
 
 
 class TradeEngine: