Comments (7)
In general, we try and make sure that each function has documentation about its
parameters (generated from the documentation that the underlying ta-lib C
library provides).
For example:
>>> import talib
>>> help(talib.RSI)
Help on built-in function RSI in module talib.func:
RSI(...)
RSI(real[, timeperiod=?])
Relative Strength Index (Momentum Indicators)
Inputs:
real: (any ndarray)
Parameters:
timeperiod: 14
Outputs:
real
What kinds of documentation are you looking for?
from ta-lib-python.
Ah yes, of course. I've been developing with Python for about half a year now, and I keep forgetting this help function. Thanks for reminding. That was all I needed.. :) . Thanks for creating all this. You saved me a couple days of work and made my week even better than it already was!
from ta-lib-python.
No problem! I love to hear feedback, and if there's anything that would make
it easier for you to use, let us know!
Also, if you use iPython, it provides the "?" operator:
$ ipython
Python 2.7.3 (default, Dec 22 2012, 21:14:12)
Type "copyright", "credits" or "license" for more information.
IPython 0.13.1 -- An enhanced Interactive Python.
? -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help -> Python's own help system.
object? -> Details about 'object', use 'object??' for extra details.
In [1]: import talib
In [2]: ?talib.RSI
Type: builtin_function_or_method
String Form:<built-in function RSI>
Docstring:
RSI(real[, timeperiod=?])
Relative Strength Index (Momentum Indicators)
Inputs:
real: (any ndarray)
Parameters:
timeperiod: 14
Outputs:
real
And, the help just grabs the function docstring (__doc__
):
>>> print talib.RSI.__doc__
RSI(real[, timeperiod=?])
Relative Strength Index (Momentum Indicators)
Inputs:
real: (any ndarray)
Parameters:
timeperiod: 14
Outputs:
real
from ta-lib-python.
Just to answer your question. If the installation of the combination of TA-lib and it's python wrapper would have been a bit easier that would be great. Preferably of course in one command and without downloading anything, but otherwise by downloading just one package and installing that.
Also, even though it is present in the docstrings, it is always interesting if all the docstrings would just be listed together with the respective functions on the website. In that way you can also check out all its functions a bit easier without needing to install everything.
I think this library is a blessing to the financial world. I presume it doesn't work under pypy (since it's in C), but if that could work it would be even better (I use pypy a lot to speed up many analyses).
For the rest. Thanks a lot again!
from ta-lib-python.
Thanks for the feedback! At least on Ubuntu, the installation problem stems from nobody having packaged TA-Lib and the python wrapper into a PPA yet. I know a bit about it so I may eventually look into that if I ever find some time. Pretty low priority though; these libraries are typically developer oriented where a little extra installation effort isn't too unexpected.
from ta-lib-python.
Using epydoc I just created a pdf listing all the functions and its inputs and outputs. I mainly did it for my own use so that I don't always have to fire up a terminal to look over the documentation in the docstrings, and also to just "scroll around"..
I suppose it could be usefull to post this on the website somewhere under documentation or something. Using epydoc you can also easily make HTML for this, which might also be easy to post it on the website.
Anyway, here is the pdf: http://hkramer.nl/opslag/ta-lib_functions.pdf
Cheers!
from ta-lib-python.
Nice, I like it!
A little bit of work got started in this regard; check out the documentation index - perhaps not as polished as your PDF but it's something basic. The code to generate the current website is actually in the repository right now if you're curious to improve it!
from ta-lib-python.
Related Issues (20)
- Help, keep looping a future warning when running all strategies on script! HOT 5
- urgently needed HOT 3
- Re: EMA indicator calculation
- Not being able to install wheel file using pip HOT 1
- Request indicator: Detrended Price Oscillator
- symbol not found in flat namespace '_TA_ACOS' on MAC M1. HOT 3
- Anaconda Installation Error HOT 4
- RSI calculation bug? HOT 3
- Installation Error HOT 7
- Instalation error Win11 system HOT 3
- Windows Installation Sources not Found HOT 2
- install problem - outdated config.guess and config.sub HOT 2
- Issue installing TA-Lib on windows HOT 10
- Building wheel for ta-lib (pyproject.toml) did not run successfully. (Ta-lib C dependency is already installed) HOT 2
- Feature Request: conda release for python 3.11 or later HOT 1
- ISSUE WITH INSTALL ta-lib on MAC Studio HOT 1
- Candle pattern 'Shooting Star' is not detected HOT 5
- ta.Category list value gets truncated HOT 2
- accidental issue, please ignore
- Pip Installation issue in Windows and Mac OS HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ta-lib-python.