Package: ritpytrading
RIT-trading-pythonPython trading module for the Rotman Interactive Trader trading
software.PyPIpage.Installation with pip:pip install ritpytradingFull documentation availableonline.A GitHub markdown flavor documentation can be found at documentation/README.md.PrerequisitesPython 3.xThe Rotman Interactive Trading ClientThe RIT Client only supportsWindows OS. However, development of the PyPI ritpytrading package
can be in done in Linux/BSD environments as well.The full documentation for the RIT Client REST API
can be found atSwaggerhub. The
documentation is also present in a JSON format in the
swagger_client_generated folder.InstallingRIT Client SoftwareThe RIT Client for Windows can be downloaded athttp://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 athttp://rit.rotman.utoronto.ca/demo.asp.Virtual environment packages withvirtualenvoranacondashould
be used for both Windows and Linux/BSD based systems.WindowsInitialize the repository with git.
Detailed instructions to download git for windows can be found atatlassian.  The repository can then be initialized with git using:$ git clone https://github.com/SamSamhuns/RIT-trading-pythonTwo options are available after this:Anaconda is recommended for Windows system. Set up up a virtual conda environment first.
Then open the anaconda prompt and use the commandconda install--yes--filerequirements.txtto install all modules from requirements.txt.Or Installpythonand add it to yourPATHsystem variable.
Then install thepippackage if not installed already also adding it to thePATHsystem variable.
Then run the following commands.$ pip install virtualenv
$ virtualenv venv
$ .\venv\Scripts\activate
$ pip install -r requirements.txtNote: When usingPowerShellin Windows, the virtual environment has to be activated with.\venv\Scripts\activate.ps1Linux/BSDAfter 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.txtBuilding dists and running tests using makefileForWindows, different options are available for using makefile.GnuWin’s makeprovides a native port for Windows (without requiring a full runtime environment like Cygwin).
After installing GnuWin, addC:\ProgramFiles(x86)\GnuWin32\binto your systemPATHvariable to run makefiles from any directory.ForWindows, run makefile commands withmake-fMakefile.win <directive>. Examplemake-fMakefile.win helpForLinux/BSD, run makefile commands withmake <directive>.Run the following command to get a list of all Makefile command options.$ make helpTo run tests$ make test
$ make test-allTo ensure the README.rst will be rendered in PyPI [might be outdated. Check twine check below]$ python setup.py check --restructuredtextTo report any problems rendering your README. If your markup renders fine, the command will output Checking distribution FILENAME: Passed. To run the check on sdist and wheel.$ twine check dist/*To build the source and wheel package.$ make distRunning tests with the python unittest moduleOnce python has been added to thePATHsystem 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 unittestIf no tests are run from the command above, run the verbose mode.Verbose mode$ python -m unittest discover -vUsage (Only on Windows)IMPORTANT:The RIT Trading client must also be running to make sure the REST RIT API Client requests can be made.In each script yourRIT Client API keymust be entered and therequestsmodule be imported to make API calls.TheAPIandAPI Ordersmode must be enabled in the RIT Client for the python module to send order requests.To test out the ritpytrading package, install using pip inside a virtual environment:$ pip install ritpytradingExamples scripts are present inside theexamplesfolder. Documentation for usage availablehere.Built WithPython 3- The Programming tool usedVersioningVersion tracked with GitAuthorsSamridha ShresthaLicenseThis project is licensed under the Apahce 2.0 License - see theLICENSE.mdfile for detailsAcknowledgmentsRotman School of Manangement, University of Torontohttp://www.rotman.utoronto.ca/Rotman Interactive Traderhttp://rit.rotman.utoronto.ca/Python open source librariesJoel Hasbrouck, NYU Stern Principles of Securities Trading,
FINC-UB.0049, Spring 201.http://people.stern.nyu.edu/jhasbrou/This project directory was created based onCookiecutterand
theaudreyr/cookiecutter-pypackageproject template.README conversion for PyPI.Pandoc.org.ContributionsDisclaimerAll RIT software and external RIT links are provided by the Rotman
School of Management and are their exclusive property.History0.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.0.1.3 (2019-01-11)Fourth release with major corrections.0.1.4 (2019-03-11)Fifth release with proper rst readme.0.1.5 (2019-07-11)Sixth release with full documentation added.0.1.6 (2020-01-27)Seventh release with bugs fixed in submit_cancel_orders.py.