Metadata-Version: 1.2
Name: ritpytrading
Version: 0.1.2
Summary: Python trading library for the Rotman Interactive Software.
Home-page: https://github.com/SamSamhuns/ritpytrading
Author: Samridha Man Shrestha
Author-email: sms1198@nyu.edu
Maintainer: Samridha Man Shrestha
Maintainer-email: sms1198@nyu.edu
License: Apache Software License 2.0
Description: ritpytrading
        ============
        
        RIT-trading-python
        ------------------
        
        |Build Status| |Updates| |Python 3| |Codacy Badge| |License|
        
        Python trading modules for the Rotman Interactive Trader trading
        software.
        
        .. image:: rit_image.PNG
            :width: 400px
            :align: left
            :height: 300px
            :alt: alternate text
        
        Prerequisites
        -------------
        
        Recommended Python version 3
        
        The Rotman Interactive Trading Client which can only be operated in a
        Windows system.
        
        The full documentation for the Rotman Interactive Trader Client REST API
        can be found at
        `Swaggerhub <https://app.swaggerhub.com/apis/306w/rit-client-api/1.0.0>`_. The
        documentation is also present in a JSON format in the
        swagger-client-generated folder.
        
        Installing
        ----------
        
        RIT Client Software
        ~~~~~~~~~~~~~~~~~~~
        
        The RIT Client for Windows system can be downloaded at
        http://rit.rotman.utoronto.ca/software.asp.
        
        Instructions for setting up an RIT demonstration client account for the
        Liability Trading 3 case file can be found at RIT’s website at
        http://rit.rotman.utoronto.ca/demo.asp.
        
        Virtual environment packages with ``virtualenv`` or ``anaconda`` should
        be used for both Windows and Linux/BSD based systems.
        
        Windows
        ~~~~~~~
        
        Download a copy of this github repository at
        https://github.com/SamSamhuns/RIT-trading-python. Two options are
        available after this:
        
        -  Anaconda is recommended for Windows system. Open the anaconda prompt
           and use the following command to install all modules from
           requirements.txt. ``conda install --yes --file requirements.txt``
        
        -  Install \ ``python``\  and add it to your ``PATH`` system variable.
           Then install the \ ``pip``\  package. The
           ``pip install -r requirements.txt`` command now be used in the
           command prompt.
        
        Linux/BSD
        ~~~~~~~~~
        
        After cloning the repository, install the required python packages using
        pip.
        
        ::
        
           $ git clone https://github.com/SamSamhuns/RIT-trading-python
           $ pip install virtualenv
           $ virtualenv venv
           $ source venv/bin/activate
           $ pip install -r requirements.txt
        
        Running the tests using makefile
        ---------------------------------------------
        
        Run the following command to get a list of all Makefile command options.
        
        ::
        
          $ make help
        
        To run tests
        
        ::
        
          $ make test
          $ make test-all
        
        To ensure the README.rst will be rendered in PyPI
        
        ::
        
          $ python setup.py check --restructuredtext
        
        Running the tests with python unittest module
        ---------------------------------------------
        
        Once python has been added to the ``PATH`` system variable in Windows,
        the code for running the scripts on Windows and Linux/BSD based systems
        are the same.
        
        From the main directory, run:
        
        ::
        
           $ python -m unittest
        
        Verbose mode
        
        ::
        
           $ python -m unittest discover -v
        
        Built With
        ----------
        
        -  `Python 3 <https://www.python.org/downloads/release/python-360/>`__
           - The Programming tool used
        
        Versioning
        ----------
        
        Version tracked online with Git
        
        Authors
        -------
        
        -  **Samridha Shrestha**
        
        License
        -------
        
        This project is licensed under the Apahce 2.0 License - see the
        `LICENSE.md <LICENSE.md>`__ file for details
        
        Acknowledgments
        ---------------
        
        -  Rotman School of Manangement, University of Toronto
           http://www.rotman.utoronto.ca/
        -  Rotman Interactive Trader http://rit.rotman.utoronto.ca/
        -  Python open source libraries
        -  Joel Hasbrouck, NYU Stern Principles of Securities Trading,
           FINC-UB.0049, Spring 201. http://people.stern.nyu.edu/jhasbrou/
        -  This project directory was created based on Cookiecutter_ and
           the `audreyr/cookiecutter-pypackage`_ project template.
        -  README conversion for PyPI. `Pandoc.org <https://pandoc.org/>`_
        
        Contributions
        -------------
        
        |contributions welcome|
        
        Disclaimer
        ----------
        
        All RIT software and external RIT links are provided by the Rotman
        School of Management and are their exclusive property.
        
        .. |Build Status| image:: https://travis-ci.org/SamSamhuns/ritpytrading.svg?branch=master
           :target: https://travis-ci.org/SamSamhuns/ritpytrading
        .. |Updates| image:: https://pyup.io/repos/github/SamSamhuns/ritpytrading/shield.svg
           :target: https://pyup.io/repos/github/SamSamhuns/ritpytrading/
        .. |Python 3| image:: https://pyup.io/repos/github/SamSamhuns/ritpytrading/python-3-shield.svg
           :target: https://pyup.io/repos/github/SamSamhuns/ritpytrading/
        .. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/5412099a50854132801b34e4e65bb327
           :target: https://www.codacy.com/app/samhunsadamant/RIT-trading-python?utm_source=github.com&utm_medium=referral&utm_content=SamSamhuns/RIT-trading-python&utm_campaign=Badge_Grade
        .. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
           :target: https://opensource.org/licenses/Apache-2.0
        .. |contributions welcome| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
           :target: https://github.com/SamSamhuns
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        History
        -------
        
        0.1.0 (2018-12-14)
        ------------------
        
        * First release on PyPI.
        
        0.1.1 (2018-12-15)
        ------------------
        
        * Second release on PyPI.
        
        0.1.2 (2018-12-15)
        ------------------
        
        * Third release on PyPI with correctly rendering README.
        
Keywords: ritpytrading
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
