Skip to content

Commit

Permalink
DOC readme adjustments TST GA python 3.12 test
Browse files Browse the repository at this point in the history
  • Loading branch information
twopirllc committed Jul 2, 2024
1 parent ee01b53 commit 8247c6c
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
# If failure occurs on one OS, it is still relevant to see which others may work
fail-fast: false
matrix:
python-version: ["3.11"]
python-version: ["3.12"]
os: [ubuntu-latest]

steps:
Expand Down
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

# Pandas TA
### A Comprehensive Python Technical Analysis Library for Traders and Investors
=================

[![license](https://img.shields.io/github/license/twopirllc/pandas-ta)](#license)
[![Python Version](https://img.shields.io/pypi/pyversions/pandas-ta?style=flat)](https://pypi.org/project/pandas_ta/)
Expand All @@ -18,20 +19,16 @@
[![Issues](https://img.shields.io/github/issues-raw/twopirllc/pandas-ta?style=flat)](#issues)
[![Closed Issues](https://img.shields.io/github/issues-closed-raw/twopirllc/pandas-ta?style=flat)](#closed-issues)
[![Buy Me a Coffee](https://img.shields.io/badge/buy_me_a_coffee-orange.svg?style=flat)](https://www.buymeacoffee.com/twopirllc)
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/K3K4ZRH9D)

<br><br>

# Description

_Pandas Technical Analysis_ ([Pandas TA](https://www.pandas-ta.dev)) is a Popular Comprehensive and Easy to Use Python 3 Technical Analysis Library with primary dependencies: _numpy_ for accuracy, _numba_ for performance, and _pandas_ for brevity and bulk processing.

<br><br>

![Example Chart](/images/SPY_Chart.png)
![Example Chart](/images/SPY_VOL.png)

<br><br>
<br>


## Features
* A Free & Open Source library with a LARGE flat library structure similar to TA Lib.
Expand All @@ -45,7 +42,7 @@ _Pandas Technical Analysis_ ([Pandas TA](https://www.pandas-ta.dev)) is a Popula
* **Tertiary:** [Sierra Chart](https://search.sierrachart.com/?Query=indicators&submitted=true) | [MQL5](https://www.mql5.com) | [FM Labs](https://www.fmlabs.com/reference/default.htm) | [Pro Real Code](https://www.prorealcode.com/prorealtime-indicators) | [User 42](https://user42.tuxfamily.org/chart/manual/index.html) | [Technical Traders](http://technical.traders.com/tradersonline/FeedTT-2014.html) | etc
* And [more ...](https://www.pandas-ta.dev/#features)

<br><br>
<br>

## About Churn
The **state** and **status** of this library and it's slowversioning increments _seem_ to be having an impact on it's long term viability and support.
Expand All @@ -56,25 +53,27 @@ This adapted variation from [Intercooler JS](https://intercoolerjs.org/docs#conc

Thus there will not be constant activity and churn on the project, but rather a stewardship relationship, where the main goal now is to not screw it up. Documentation and testing will be improved, features/indicators will be added/removed as needed, but there will be no massive rewrite or constant updating. This is in contrast with the software industry in general, which often has comical levels of churn."

<br><br>

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=twopirllc/pandas-ta&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=twopirllc/pandas-ta&type=Date" />
<img alt="Pandas TA Project Star History Chart" src="https://api.star-history.com/svg?repos=twopirllc/pandas-ta&type=Date" />
</picture>

<br><br>
<br>


# Support :broken_heart:
**A big thank you to all current and past sponsors, whose generous support has been and continues to be essential to the success of the project!** :pray:

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/twopirllc)
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/K3K4ZRH9D)

Despite what the usage metrics indicate, current and past levels of support are **unsustainable** for maintaining and improving the library. Unless significant additional support is provided by _July 1st, 2026_, this widely used library will be **archived**. Support through [contributions](https://github.com/twopirllc/pandas-ta/labels/help%20wanted), [donations](https://www.buymeacoffee.com/twopirllc) & [sponsorships](https://github.com/twopirllc) is **necessary** to ensure the project's continued success and development.

:stop_sign: Please* **DO NOT** email me personally with Pandas TA Bugs, Issues or Feature Requests that are best handled via Github [Issues](https://github.com/twopirllc/pandas-ta/issues).

<br><br>
<br>


# Installation
Before installing, review the installation [requirements.txt](https://github.com/twopirllc/pandas-ta/requirements.txt) to ensure your system is set up properly.
Expand All @@ -98,42 +97,44 @@ $ pip install -U git+https://github.com/twopirllc/pandas-ta.git@development
### Local Installation
Click on green [<> Code](https://github.com/twopirllc/pandas-ta) button to download the source zip and unzip in your application directory. Then perform a local install.

<br><br>
<br>


# Bugs, Indicators and Feature Requests
* Some bugs and features may already be fixed or implemented in the _development_ version. _Please_ try the _development_ version first **before** making an issue!
* If the _development_ version does not resolve the bug, search both _Open_ and _Closed_ [Issues](https://github.com/twopirllc/pandas-ta/issues) **before** opening a new Issue.

<br><br>
<br>

# Contributors

# Contributors
Your help has continues to be integral to this project. Thank you for your help! :sunglasses:
<a href="https://github.com/twopirllc/pandas-ta/graphs/contributors">
<img src="https://contrib.rocks/image?&columns=25&max=10000&&repo=twopirllc/pandas-ta" noZoom />
</a>

<br><br>
<br>

# Contributing

# Contributing
Anyone who wishes to contribute to this project - be it documentation, features, bug fixes, code cleanup, testing, open issue help, or code reviews - are encouraged to do so. These contributions are crucial to the longevity of this project.

Based on your skill level, select from the following issue topics:

[Good First Issue](https://github.com/twopirllc/pandas-ta/labels/good%20first%20issue) | [Bugs](https://github.com/twopirllc/pandas-ta/labels/bug) | [Help Wanted](https://github.com/twopirllc/pandas-ta/labels/help%20wanted) | [Enhancements](https://github.com/twopirllc/pandas-ta/labels/enhancement)

<br><br>
<br>


# Code of Conduct
See the [Code of Conduct](https://github.com/twopirllc/pandas-ta?tab=coc-ov-file) regarding handling yourself and dealing with others in and around the Pandas TA community. Ensure you completely understand the "common sense" **Guidelines** outlined there.

<br><br>
<br>


# License
[MIT](https://github.com/twopirllc/pandas-ta/LICENSE)

<br><br>
<br>

Copyright © 2024 - Pandas TA

0 comments on commit 8247c6c

Please sign in to comment.