Karl/freetrade_stock_price
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): update documentation for

Browse Source
This commit is contained in:
Karl Hudgell 2026-04-20 12:32:55 +01:00
parent ddec1e3683
commit 9c89c9da9e
3 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -20,12 +20,12 @@ Copy the sample file and add your own positions:
cp holdings.sample.csv holdings.csv cp holdings.sample.csv holdings.csv
``` ```
Format (`ticker,market,shares`): Format (`name,ticker,market,shares`):
```csv ```csv
GGP,GB,100 Greatland Resources,GGP,GB,6
PAF,GB,200 Pan African Resources,PAF,GB,78
SVM,US,50 Nvidia,NVDA,US,0.09761572
``` ```
Markets: `GB` for UK stocks, `US` for US-listed stocks. Markets: `GB` for UK stocks, `US` for US-listed stocks.
@ -42,11 +42,14 @@ Output (JSON):
```json ```json
[ [
{ {
"name": "Greatland Resources",
"ticker": "GGP", "ticker": "GGP",
"market": "GB", "market": "GB",
"shares": 100, "shares": 6,
"price": 7.67, "currency": "GBP",
"total_value": 767.0 "price": 7.69,
"fx_rate": 1.0,
"total_value_gbp": 46.14
} }
] ]
``` ```

6
holdings.sample.csv
View File

@ -1,4 +1,2 @@
GGP,GB,100 test1,GGP,GB,100
PAF,GB,200 test2,AAPL,US,3.6185
SVM,US,50
AAPL,US,3.6185
1 test1 GGP GB 100
2 test2 PAF AAPL GB US 200 3.6185
SVM US 50
AAPL US 3.6185

6
price.py
View File

@ -39,10 +39,10 @@ holdings = []
with open(holdings_file) as f: with open(holdings_file) as f:
reader = csv.reader(f) reader = csv.reader(f)
for row in reader: for row in reader:
ticker, market = row[0].strip(), row[1].strip() name, ticker, market = row[0].strip(), row[1].strip(), row[2].strip()
shares = float(row[2].strip()) shares = float(row[3].strip())
currency = get_currency(market) currency = get_currency(market)
holdings.append({"ticker": ticker, "market": market, "shares": shares, "currency": currency}) holdings.append({"name": name, "ticker": ticker, "market": market, "shares": shares, "currency": currency})
unique_currencies = {h["currency"] for h in holdings if h["currency"] != "GBP"} unique_currencies = {h["currency"] for h in holdings if h["currency"] != "GBP"}
for currency in unique_currencies: for currency in unique_currencies: