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.

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.5.tar.gz (4.2 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.5-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

Hashes for papertrades-1.0.5.tar.gz
Algorithm Hash digest
SHA256 acac8e40742d80877d44d465217400a62084879e81f05478300c124da703212e
MD5 a6aa89de809f6a84a2cc1617c2884e3f
BLAKE2b-256 3557755d2e5e813804a64ece65455161f3e91b83449e368dbc6b145219209158

See more details on using hashes here.

File details

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

File metadata

  • Download URL: papertrades-1.0.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3962d7af97c034c23e0929a568fa14a5e2740b04e4e77a423e6790c8797d0bc3
MD5 97513b111fad6092ec609ebd1fd0870a
BLAKE2b-256 b5437d9bf1da3856c9afe244a2dbbce349aa3d9b97af51cff66dd92ef6f622b5

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