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 PyPI version

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: papertrades-1.0.7.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.7.tar.gz
Algorithm Hash digest
SHA256 6a1783762e36e040b7c6f4b6303c255d0adbf693c2caa6692702701967a626ee
MD5 c21f7aab2ba1c5bb150b06aea0744c17
BLAKE2b-256 c5a967283e294a27c339ea7b2d8c8dbad2e90c8509e6c9734f2391e24986a21e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: papertrades-1.0.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d73d3f835293e6feb57efca0b92b084b0551552204096cd877f6f2a79aae9877
MD5 50654e1dfc1ac66ac4ba72adefacae16
BLAKE2b-256 59d39ba90fc8983df67a2928518a5b78bf10647dbe5cdeb4001a65a7daf8e4e1

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