https://github.com/westonplatter/finx-tracker
Web app to track PnL for options & futures strategies.
https://github.com/westonplatter/finx-tracker
django futures interactivebrokers options python
Last synced: about 2 months ago
JSON representation
Web app to track PnL for options & futures strategies.
- Host: GitHub
- URL: https://github.com/westonplatter/finx-tracker
- Owner: westonplatter
- License: bsd-3-clause
- Created: 2022-05-11T05:33:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-18T23:19:00.000Z (over 1 year ago)
- Last Synced: 2024-04-14T20:10:43.265Z (about 1 year ago)
- Topics: django, futures, interactivebrokers, options, python
- Language: Python
- Homepage:
- Size: 352 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# finx-tracker
Web app to track PnL for options & futures strategies.
This codebase aims to
- do few things well
- ingest trades & positions from broker
- allow users to declare portfolio specific strategies
- expose trades for user to link trades to strategies
- report PnL on portfolio/strategy/grouping levels
## Running
### Getting started
Tracker is built in with a soft linking data dependency to [finx-reports-ib](https://github.com/westonplatter/finx-reports-ib). The following scripted steps assume that it's setup in a adjacent directory. Checkout the `finx-reports-ib` for more info on it.
NOTE - if using colima, https://smallsharpsoftwaretools.com/tutorials/use-colima-to-run-docker-containers-on-macos/
```
mkdir -finx
cd finx
git clone [email protected]:westonplatter/finx-tracker.git
git clone [email protected]:westonplatter/finx-reports-ib.git
cd finx-tracker.git
docker-compose -f local.yml build
make db.migrate
# run this, cd ../finx-ib-reports && make download.annual && finx-tracker
make import.trades
```
### Importing trades
Run this,
```
cp ../finx-ib-reports/data/* data
docker-compose -f local.yml run django-cli python manage.py runscript import_trades
```
### Importing positions
Run this,
```bash
cp ../finx-reports-ib/data/* data
docker-compose -f local.yml run django-cli python manage.py runscript import_positions
```
### Running the UI
Run this,
```bash
make docker.up.django
```
### DB / Migrations
Run this,
```
docker-compose -f local.yml run django-cli python manage.py makemigrations [optional: app_name]
docker-compose -f local.yml run django-cli python manage.py migrate [optional: app_name]
```
## Test coverage
To run django based tests,
```
docker-compose -f local.yml run django-cli python manage.py test
```
## License
BSD-v3. See license file