semvec/pypi-packages huggingface dataset:
wealthsimple-trade-python 1.1.0
Python wrapper for the Wealthsimple Trade API
License: MIT
Requires Python: !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
Keywords: wealthsimple,trade,finance,stocks,market,api,wrapper

=========================
Wealthsimple Trade Python
=========================
A convenient Python wrapper for the Wealthsimple Trade API. Note that this wrapper is Unofficial and is not in any way affiliated with Wealthsimple. Please use at your own risk.

.. start-badges

.. list-table::
    :stub-columns: 1

    * - docs
      - |docs|
    * - tests
      - | |travis| |requires|
    * - package
      - | |commits-since|
.. |docs| image:: https://readthedocs.org/projects/wealthsimple-trade-python/badge/?version=latest
    :target: https://wealthsimple-trade-python.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
    
.. |travis| image:: https://api.travis-ci.org/seansullivan44/Wealthsimple-Trade-Python.svg?branch=master
    :alt: Travis-CI Build Status
    :target: https://travis-ci.org/seansullivan44/Wealthsimple-Trade-Python

.. |requires| image:: https://requires.io/github/seansullivan44/Wealthsimple-Trade-Python/requirements.svg?branch=master
    :alt: Requirements Status
    :target: https://requires.io/github/seansullivan44/Wealthsimple-Trade-Python/requirements/?branch=master

.. |commits-since| image:: https://img.shields.io/pypi/v/wealthsimple-trade-python
    :alt: Commits since latest release
    :target: https://pypi.org/project/wealthsimple-trade-python/

.. end-badges


Installation
============

::

    pip install wealthsimple-trade-python

You can also install the in-development version with::

    pip install https://github.com/seansullivan44/Wealthsimple-Trade-Python/archive/master.zip

*Note*: `node` is a dependency of this project. See [here](https://github.com/VeNoMouS/cloudscraper#dependencies) for more information.

Getting Started
===============
Download the Wealthsimple Trade app for iOS or Android and create an account. This API wrapper will use your Wealthsimple Trade login credentials to make successful API calls. After creating an account, use your login credentials to create a WSTrade object:
::

    import wealthsimple
    WS = wealthsimple.WSTrade('email', 'password')

If your Wealthsimple Trade account uses two-factor authentication then you must provide the `WSTrade` object with a callback function as shown in the following example: 
::

    import wealthsimple

    def my_two_factor_function():
        MFACode = ""
        while not MFACode:
            # Obtain user input and ensure it is not empty
            MFACode = input("Enter 2FA code: ")
        return MFACode

    ws = wealthsimple.WSTrade(
        "email",
        "password",
        two_factor_callback=my_two_factor_function,
    )
    
Documentation
=============


https://Wealthsimple-Trade-Python.readthedocs.io/