a tool to simulate and analyze paper trades in Python
Project description
papertrades
papertrades is a tool to simulate and analyze paper trades in Python
- HomePage: https://github.com/kzhu2099/Paper-Trades
- Issues: https://github.com/kzhu2099/Paper-Trades/issues
Author: Kevin Zhu
THIS IS NOT FINANCIAL ADVICE; papertrades IS A TOOL TO SIMULATE THE MARKET FOR EDUCATIONAL PURPOSES.
Features
- multiple portfolios
- automatic asset price calculation based on your last trade
- plotting of the value of your portfolio
- remaining cash (balance) calculation & value calculation
- asset breakdown
Installation
To install papertrades, use pip: pip install papertrades.
However, many prefer to use a virtual environment (or any of their preferred choice).
macOS / Linux:
# make your desired directory
mkdir /path/to/your/directory
cd /path/to/your/directory
# setup the .venv (or whatever you want to name it)
pip install virtualenv
python3 -m venv .venv
# install papertrades
source .venv/bin/activate
pip install papertrades
deactivate # when you are completely done
Windows CMD:
# make your desired directory
mkdir C:path\to\your\directory
cd C:path\to\your\directory
# setup the .venv (or whatever you want to name it)
pip install virtualenv
python3 -m venv .venv
# install papertrades
.venv\Scripts\activate
pip install papertrades
deactivate # when you are completely done
Usage
Create a portfolio with a starting balance and a path for its trades. Once you make trades, you make save the trades to use later, and load them from the portfolio. See the example for complete functionality with all methods!
After a lot of time,
License
The License is an MIT License found in the LICENSE file.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file papertrades-1.0.4.tar.gz.
File metadata
- Download URL: papertrades-1.0.4.tar.gz
- Upload date:
- Size: 4.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f978a15506a087ee4661fb5c8b1c42237cc6f5887cbbeb3cae8d72fc7a9f0be6
|
|
| MD5 |
31f9cae3fd9d8e24a581815d3a4bb030
|
|
| BLAKE2b-256 |
395a3286e65069b49dbcd87d1c27461ef051980967e2815d8143b71a4ae8c670
|
File details
Details for the file papertrades-1.0.4-py3-none-any.whl.
File metadata
- Download URL: papertrades-1.0.4-py3-none-any.whl
- Upload date:
- Size: 4.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5e836e6e9d744361ae0bcb24aeaf2bf4fca0bc75e3d2f35613dcf0af2d7e7829
|
|
| MD5 |
dd52abb49cf19f2ae6f8b5f6c3f470f7
|
|
| BLAKE2b-256 |
24f020f5967b738086c8493aed07e529ce9de63ccb565199008084332478d7bf
|