Skip to main content

Python package to create stock related features.

Project description

stockfeat

Python PyPI Version License Coffee Github Forks GitHub Open Issues Project Status Sphinx Downloads Downloads

  • stockfeat is Python package

Installation

  • Install stockfeat from PyPI (recommended). stockfeat is compatible with Python 3.6+ and runs on Linux, MacOS X and Windows.
  • A new environment can be created as following:
conda create -n env_stockfeat python=3.8
conda activate env_stockfeat
pip install stockfeat            # normal install
pip install --upgrade stockfeat # or update if needed
  • Alternatively, you can install from the GitHub source:
# Directly install from github source
pip install -e git://github.com/erdogant/stockfeat.git@0.1.0#egg=master
pip install git+https://github.com/erdogant/stockfeat#egg=master
pip install git+https://github.com/erdogant/stockfeat

# By cloning
git clone https://github.com/erdogant/stockfeat.git
cd stockfeat
pip install -U .

Import stockfeat package

from stockfeat import stockfeat

Example:

sf = stockfeat(col_open='Open', col_close='Close', col_volume='Volume', col_high='High', col_low='Low')
df = sf.download_example()
df = df.resample('D').mean()

# Collect features
X = sf.fit(df)

Citation

Please cite stockfeat in your publications if this is useful for your research. Here is an example BibTeX entry:

@misc{erdogant2020stockfeat,
  title={stockfeat},
  author={Erdogan Taskesen},
  year={2020},
  howpublished={\url{https://github.com/erdogant/stockfeat}},
}

References

Maintainer

  • Erdogan Taskesen, github: erdogant
  • Contributions are welcome.
  • If you wish to buy me a Coffee for this work, it is very appreciated :) Star it if you like it!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stockfeat-0.1.0.tar.gz (21.3 kB view hashes)

Uploaded Source

Built Distribution

stockfeat-0.1.0-py3-none-any.whl (23.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page