This Python tool allows for the calculation of key stock market metrics, including the Dividend Yield, P/E Ratio, Volume Weighted Stock Price (VWSP), and the GBCE All Share Index for a predefined set of stocks.
- Calculate the Dividend Yield for a given stock.
- Compute the P/E Ratio for a given stock.
- Record trades for any stock, including timestamp, quantity, buy/sell indicator, and price.
- Calculate the Volume Weighted Stock Price for trades within the past 15 minutes.
- Calculate the GBCE All Share Index using the geometric mean of the volume weighted stock prices for all stocks.
Ensure you have Python 3.7 or higher installed on your system.
Clone the repository to your local machine.
git clone https://github.com/ChuckTG/broker.git
cd brokerUsage Calculating Stock Metrics To use the tool for calculating stock metrics, import and create instances of the Stock class in broker.py. Here is a basic example:
from broker import Stock
# Create a stock instance
stock = Stock('GIN', 'Preferred', 8, 0.02, 100)
# Record some trades
stock.record_trade(100, 'buy', 105)
stock.record_trade(200, 'sell', 110)
# Calculate Dividend Yield
print(f"Dividend Yield: {stock.dividend_yield(105)}")
# Calculate P/E Ratio
print(f"P/E Ratio: {stock.pe_ratio(105)}")
# Calculate Volume Weighted Stock Price
print(f"Volume Weighted Stock Price: {stock.volume_weighted_stock_price()}")Calculating the GBCE All Share Index To calculate the GBCE All Share Index for a list of stocks:
from broker import Stock, calculate_gbce_all_share_index
stocks = [
Stock('TEA', 'Common', 0, None, 100),
Stock('POP', 'Common', 8, None, 100),
Stock('ALE', 'Common', 23, None, 60),
Stock('GIN', 'Preferred', 8, 0.02, 100),
Stock('JOE', 'Common', 13, None, 250)
]
stocks[0].record_trade(100, 'buy', 105)
stocks[1].record_trade(200, 'sell', 110)
# Assuming stocks is a list of Stock instances
print(f"GBCE All Share Index: {calculate_gbce_all_share_index(stocks)}")To run tests use the following command:
python -m unittest test_broker.py
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent