Metadata-Version: 2.1
Name: econcycle
Version: 0.0.8
Summary: Get Calculated Economic Cycle
Home-page: https://github.com/skwon2345/econcycle
Author: Sukkwon On
Author-email: skwon2345@gmail.com
Project-URL: Bug Tracker, https://github.com/skwon2345/econcycle/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# econcycle

This package is to define economic cycle for a given timeframe. (Inflation, Recession, Goldilocks)

It also gives trend information of the stock.

## Installation

Install package

```sh
pip install econcycle
```

## Getting Started

```python
from econcycle.utils.cycle import Cycle
from econcycle.utils.chart import Chart

start_date = "2020-01-01 00:00:00"
end_date = "2022-11-08 00:00:00"

resolution = "W"

# This period is used to calculate trend of candle data.
# If it is uptrend, the chart is going up,
# If it is downtrend, the chart is going down
period = 5

# Get all cycles (Inlfation, Recession, Goldilocks)
cycle = Cycle(resolution, period, start_date, end_date)
all_cycle = cycle.get_all()

print(all_cycle)

# Get chart data of AAPL
aapl = chart.process("AAPL")
print(aapl)

# Get trend information (uptrend, downtrend)
print(aapl.get("type"))

```

## License

MIT
