Commit80cfe05

authored

* add setup.py and update readme* updated installation instructions and sample strategy (michaelchu#3)

1 parent134b0d7 commit80cfe05Copy full SHA for 80cfe05

File tree

+44

-13

lines changed

+44

-13

lines changed

Lines changed: 14 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,19 @@ the rapid development of complex options trading strategies.`
`60`	`60`	`* Stock Price Distribution Generator - Analyze historical stock price movements patterns to discover potential trade ideas.`
`61`	`61`	`* Trade Scanner - Used to recommend trades based on stock price distributions`
`62`	`62`
	`63`	`+###Dependencies`
	`64`	`+You will need Python 3.6.x. It is recommended to install[Miniconda3](https://conda.io/miniconda.html). See[requirements.txt](https://github.com/michaelchu/optopsy/blob/master/requirements.txt) for full details.`
	`65`	`+`
	`66`	`+###Installation`
	`67`	+```
	`68`	`+pip install optopsy`
	`69`	+```
	`70`	`+`
`63`	`71`	`###Usage`
	`72`	+```
	`73`	`+python strategies/sample_strategy.py`
	`74`	+```
	`75`	`+The sample strategy can be used with[Level 3 Historical CSV Data Sample](https://www.historicaloptiondata.com/content/sample-files-0?gclid=CjwKCAjwtIXbBRBhEiwAWV-5ngKHMIxUw_rCK1DnkQpS4BUs_XQmLG09hm4SWpE9FoMJc3hb6qMPqhoCGgIQAvD_BwE) from historicaloptiondata.com.`
	`76`	`+`
	`77`	`+In order to use it, you will need to define the struct variable to map the column names to the numerical index as per the file format.`
`64`	`78`
`65`		`-Coming Soon.`

Lines changed: 18 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,18 @@`
	`1`	`+fromsetuptoolsimportsetup`
	`2`	`+`
	`3`	`+setup(name='optopsy',`
	`4`	`+description='Python Backtesting library for options trading strategies',`
	`5`	`+long_description=open("README.md").read(),`
	`6`	`+version='0.1.0',`
	`7`	`+url='https://github.com/michaelchu/optopsy',`
	`8`	`+author='Michael Chu',`
	`9`	`+author_email='mchchu88@gmail.com',`
	`10`	`+license='MIT',`
	`11`	`+classifiers=[`
	`12`	`+"Operating System :: OS Independent",`
	`13`	`+'License :: OSI Approved :: MIT License',`
	`14`	`+'Programming Language :: Python :: 3'`
	`15`	`+ ],`
	`16`	`+packages=['optopsy']`
	`17`	`+)`
	`18`	`+`

Lines changed: 12 additions & 12 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,23 +9,23 @@`
`9`	`9`	`vxx_struct= (`
`10`	`10`	`('symbol',0),`
`11`	`11`	`('underlying_price',1),`
`12`		`- ('option_symbol',2),`
`13`		`- ('option_type',3),`
`14`		`- ('expiration',4),`
`15`		`- ('quote_date',5),`
`16`		`- ('strike',6),`
`17`		`- ('bid',8),`
`18`		`- ('ask',9),`
`19`		`- ('delta',13),`
`20`		`- ('gamma',14),`
`21`		`- ('theta',15),`
`22`		`- ('vega',16)`
	`12`	`+ ('option_symbol',3),`
	`13`	`+ ('option_type',4),`
	`14`	`+ ('expiration',5),`
	`15`	`+ ('quote_date',6),`
	`16`	`+ ('strike',7),`
	`17`	`+ ('bid',9),`
	`18`	`+ ('ask',10),`
	`19`	`+ ('delta',17),`
	`20`	`+ ('gamma',18),`
	`21`	`+ ('theta',19),`
	`22`	`+ ('vega',20)`
`23`	`23`	`)`
`24`	`24`
`25`	`25`
`26`	`26`	`defrun_strat():`
`27`	`27`	`# fetch the option chains from our data source`
`28`		`-d=op.get('../data/VXX.csv',`
	`28`	`+d=op.get('data/VXX.csv',`
`29`	`29`	`start=date(2016,12,1),`
`30`	`30`	`end=date(2016,12,31),`
`31`	`31`	`struct=vxx_struct,`

Comments

(0)