Merge pull request #1 from Nicolivain/cleanup-code

Cleanup code
Nicolivain · Jun 1, 2024 · 2d483e3 · 2d483e3
2 parents b626c66 + de2cb5f
commit 2d483e3
Show file tree

Hide file tree

Showing 17 changed files with 1,920 additions and 679 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,31 @@
-# PortfolioTracker
-A python-augmented excel sheet to track portfolio performance.
+# Portfolio Tracker
+A python-augmented excel spreadsheet to track portfolio performance.  
+Supports multiple books with multiple currencies.  
+The framework is easily extendable to add extra plots or reports.
+
+## Visuals
+
+![](figs/landing.png)
+
+![](figs/portfolio_view.png)
+
+## Getting started
+
+Install the poetry environment:
+
+```
+> conda env create -f environment.yaml -n portfolio-tracker
+```
+
+```
+> poetry install
+```
+
+You may have to install `xlwings` add on for excel to run the code.
+The `main.xlsm` is connected to accordingly named `main.py`. 
+You can update the example sheet by running the main run button within excel xlwings' tab or run the script from the terminal:
+
+```
+> conda activate portfolio-tracker
+> python main.py
+```
diff --git a/env.yaml b/env.yaml
diff --git a/environment.yaml b/environment.yaml
@@ -0,0 +1,5 @@
+name: portfolio-tracker
+dependencies:
+  - black=23.11.0
+  - pip:
+      - poetry
diff --git a/figs/landing.png b/figs/landing.png
diff --git a/figs/portfolio_view.png b/figs/portfolio_view.png