Skip to main content

a package to simulate and analyze paper trades in Python

Project description

papertrades

papertrades is a package to simulate and analyze paper trades in Python.

Many tools exist online for simulation paper trading. However, users may not find them to be up to their standards. papertrades changes this by allowing full customization.

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.6.tar.gz (4.3 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.6-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: papertrades-1.0.6.tar.gz
  • Upload date:
  • Size: 4.3 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.6.tar.gz
Algorithm Hash digest
SHA256 240247d7ac6b9da0cb2d4b99d63ce50a50b73e47a176a6e21f6cce4d00318581
MD5 39766cf576626a4c1e8d39ee16772237
BLAKE2b-256 7fa6dd814fc4785e505d7c99793bd138012964a32c0e87b905b8728837d277a8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: papertrades-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 4.1 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f4fac623a5ec9822a7cce2d6611cfecb9f31f58a374e50b53d110f1f5d5db5f0
MD5 58ae26054309001cb24307405973c06d
BLAKE2b-256 bbbfca637ab8bd431585e88df9d5c5228f0f6c59ff1ed7a2ff34a92320196c30

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