Skip to main content

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

PyPI Downloads

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

papertrades-1.0.3.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

papertrades-1.0.3-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file papertrades-1.0.3.tar.gz.

File metadata

  • Download URL: papertrades-1.0.3.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for papertrades-1.0.3.tar.gz
Algorithm Hash digest
SHA256 2b5289fe72ee38de86fc49b13ee9e35ca678bf2558d41321904ffee55883b283
MD5 595490a0a5a3b74d89ccc8a1e9fcfc02
BLAKE2b-256 4dda6b2143819776af48e85d231a652f2f36131b05fa8056c433193da47afb25

See more details on using hashes here.

File details

Details for the file papertrades-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: papertrades-1.0.3-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

Hashes for papertrades-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 298b3ed8a03b576517297baedb04463abc8ad4860f09bd08ffecac39601c4efd
MD5 d92b0dc042f3f1da2b3a50c0a2758394
BLAKE2b-256 c5a33d48d971548ecfe6b93f0071b1f5ff30d271dec0b3bfc5401e3873aaf84e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page