Metadata-Version: 2.1
Name: algoind
Version: 0.0.2
Summary: A collection of technical indicators for backtesting and for implementing trading strategies in Python3.
Project-URL: Homepage, https://github.com/matteoincremona/techind
Project-URL: Bug Tracker, https://github.com/matteoincremona/techind/issues
Author-email: Matteo Incremona <matteoincremona82@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Matteo Incremona
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE.txt
Keywords: backtesting,finance,indicator,pandas,quantitative,trading
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

<h1 align="center">ALGOIND: A Technical Indicators collection in Python.</h1>

<div align="center">
<img src="https://komarev.com/ghpvc/?username=matteoincremona&label=Profile%20views&color=blueviolet&style=flat" /> </a>
<img src ="https://img.shields.io/badge/pipy-%3E%20v3.7-blue" /> </a>
<img src ="https://img.shields.io/badge/version-0.0.1-green" /> </a>
<img src= "https://raw.githubusercontent.com/matteoincremona/algoind/main/logo.svg">

<div align="left">

# 🔎 What is it

- **algoind** is python3 package that contains technical indicators for backtesting and for implementing trading strategies in Python3.

- ### 😃 Who I am
  - My name is Matteo, a 21 years old FinTech student.
  - I created this library for my personal usage and I decided publish it because it think can be useful for someone.
  - 👋 You can find my [contacts here].

- The source code is currently hosted on GitHub at: https://github.com/...

- Thanks to [Investopedia.com] that provided me a vast amount of knowledge to be able to create this library.

# 💻 How to Install it
```sh
# conda
conda install -c conda-forge algoind
```

```sh
# PyPI
pip install algoind
```

# 📈 Features 
This is the list of all the indicators **algoind** contains:

  - Single Moving Average (**SMA**)
  - Esponential Moving Average (**EMA**)
  - Average True Range (**ATR**)
  - Relative Strenght Index (**RSI**)
  - Upper Bollinger Bands (**BBU**)
  - Lower Bollinger Bands (**BBL**)
  - Mid Bollinger Bands (**BBM**)
  - Moving Average Convergence Divergence (**MACD**)
  - Moving Average Convergence Divergence Signal (**MACDsignal**)

# ✅ Example: How to use it

```sh
# After the installation of the package:
import algoind
from algoind import xxx

# Let's try SMA: what should we know about it?
help(SMA)

# Let's try SMA that takes, for example:
# - The close prices of a df called data: "data.Close"
# - The period for the calculation of the SMA: "20"
SMA20 = SMA(pandas.Close, 20)

# To see the values of the indicator:
SMA20
```
# ⚙️ Discussion and Development
I will be very enthusiastic if somebody would like to help me with this project.

[Contact me] if you have any **problem** or if you want me to add **new indicators**.

Thank you.

[contacts here]: https://github.com/matteoincremona/matteoincremona/
[Investopedia.com]: https://www.investopedia.com
[Contact me]: https://github.com/matteoincremona/matteoincremona/
