https://github.com/dmotte/smartchg

🐍 DCA-based asset exchange algorithm
https://github.com/dmotte/smartchg

algorithm apy asset averaging calculator change command csv dca exchange invest package pip pypi python return smart smartchg value yield

Last synced: 3 days ago
JSON representation

🐍 DCA-based asset exchange algorithm

• Host: GitHub
• URL: https://github.com/dmotte/smartchg
• Owner: dmotte
• License: mit
• Created: 2024-12-23T00:53:23.000Z (9 days ago)
• Default Branch: main
• Last Pushed: 2024-12-23T02:08:25.000Z (9 days ago)
• Last Synced: 2024-12-23T02:15:17.038Z (9 days ago)
• Topics: algorithm, apy, asset, averaging, calculator, change, command, csv, dca, exchange, invest, package, pip, pypi, python, return, smart, smartchg, value, yield
• Language: Python
• Homepage: https://pypi.org/project/smartchg/
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# smartchg

[![GitHub main workflow](https://img.shields.io/github/actions/workflow/status/dmotte/smartchg/main.yml?branch=main&logo=github&label=main&style=flat-square)](https://github.com/dmotte/smartchg/actions)

[![PyPI](https://img.shields.io/pypi/v/smartchg?logo=python&style=flat-square)](https://pypi.org/project/smartchg/)

:snake: DCA-based **asset exchange algorithm**.

## Installation

This utility is available as a Python package on **PyPI**:

```bash

pip3 install smartchg

```

## Usage

There are some files in the [`example`](example) directory of this repo that can be useful to demonstrate how this tool works, so let's change directory first:

```bash

cd example/

```

We need a Python **virtual environment** ("venv") with some packages to do the demonstration:

```bash

python3 -mvenv venv

venv/bin/python3 -mpip install -r requirements.txt

```

Now we need to **fetch data** related to some asset. To do that, we can use https://github.com/dmotte/misc/blob/main/python-scripts/ohlcv-fetchers/yahoo-finance.py.

> **Note**: in the following commands, replace the local path of the `invoke.sh` script with the correct one.

```bash

~/git/misc/python-scripts/ohlcv-fetchers/invoke.sh yahoo-finance '^GSPC' -i1d -d2020-01-01T00Z -f'{:.6f}' > ohlcv-SPX500.csv

```

Now that we have the data, we can **compute the output data and values**:

```bash

rate=$(tail -1 ohlcv-SPX500.csv | cut -d, -f6)

python3 -msmartchg -a.15 -r"$rate" -t1000 --fmt-src='{:.2f}' --fmt-dst='{:.4f}' --fmt-{rate,simil}='{:.6f}' {ohlcv,smartchg,values}-SPX500.csv

grep '^sugg_' values-SPX500.csv

```

> **Note**: each **output value** and **entry field** is described with a comment in the `compute_stuff` function's code. You can search for the strings `# - entry` and `# - values` in the [`smartchg/cli.py`](smartchg/cli.py) file to get an overview.

And finally display some nice **plots** using the [`plots.py`](example/plots.py) script (which uses the [_Plotly_](https://github.com/plotly/plotly.py) Python library):

```bash

venv/bin/python3 plots.py -ros {smartchg,values}-SPX500.csv

```

For more details on how to use this command, you can also refer to its help message (`--help`).

## Algorithm

TODO describe the algorithm here using LaTeX formulas (with `$$ ... $$`)

## Development

If you want to contribute to this project, you can install the package in **editable** mode:

```bash

pip3 install -e . --user

```

This will just link the package to the original location, basically meaning any changes to the original package would reflect directly in your environment ([source](https://stackoverflow.com/a/35064498)).

If you want to run the tests, you'll have to install the `pytest` package and then run:

```bash

pytest test

```