@@ -2,7 +2,7 @@ ritpytrading
22============
33
44RIT-trading-python
5- ------------------
5+
66
77|PyPI pyversions | |Build Status | |PyPI version fury.io | |Codacy Badge | |License |
88
@@ -23,7 +23,7 @@ A GitHub markdown flavor documentation can be found in ``documentation/README.md
2323 :alt: Image not available.
2424
2525Requirements
26- ------------
26+
2727
2828- Python 3.6+
2929
@@ -36,7 +36,7 @@ The full documentation for the RIT Client REST API can be found at `Swaggerhub <
3636The swagger API documentation is also provided in the ``swagger_client_generated `` folder.
3737
3838Usage (Only on Windows)
39- ---------------------------------------------
39+
4040
4141**IMPORTANT: **
4242
@@ -53,13 +53,13 @@ Usage (Only on Windows)
5353Examples scripts are present inside the ``examples `` folder. Documentation available `here. <https://samsamhuns.github.io/docs/html/index.html >`_
5454
5555Developers Guide
56- ________________
56+
5757
5858Setup
59- ~~~~~
59+
6060
6161RIT Client
62- ~~~~~~~~~~
62+
6363
6464The RIT Client for Windows can be downloaded at
6565http://rit.rotman.utoronto.ca/software.asp.
@@ -70,7 +70,7 @@ http://rit.rotman.utoronto.ca/demo.asp.
7070
7171
7272Windows
73- ~~~~~~~
73+
7474
7575Initialize the repository with git.
7676Detailed instructions to download git for windows can be found at `atlassian <https://www.atlassian.com/git/tutorials/install-git#windows >`_. The repository can then be initialized with git using:
@@ -98,19 +98,18 @@ Two options are available after this:
9898Note: When using **PowerShell ** in Windows, the virtual environment has to be activated with ``.\venv\Scripts\activate.ps1 ``
9999
100100Linux/BSD
101- ~~~~~~~~~
101+
102102
103103After cloning the repository, install packages using pip.
104104
105105::
106106
107107 git clone https://github.com/SamSamhuns/RIT-trading-python
108- python -m venv venv
109- source venv/bin/activate
108+ python -m venv venv; source venv/bin/activate
110109 pip install -r requirements.txt
111110
112111Building dists and running tests using makefile
113- -----------------------------------------------
112+
114113
115114For **Windows **, different options are available for using makefile. `GnuWin's make `_
116115provides a native port for Windows (without requiring a full runtime environment like Cygwin).
@@ -156,7 +155,7 @@ To upload the distribution code to PyPi. The version number must be updated in `
156155 twine upload dist/*
157156
158157Running tests with the python unittest module
159- ---------------------------------------------
158+
160159
161160Once python has been added to the ``PATH `` system variable in Windows,
162161the code for running the scripts on Windows and Linux/BSD based systems
@@ -177,18 +176,18 @@ Verbose mode
177176 python -m unittest discover -v
178177
179178Authors
180- -------
179+
181180
182181- **Samridha Shrestha **
183182
184183License
185- -------
184+
186185
187186This project is licensed under the `Apache 2.0 ` License - see the
188187`LICENSE.md <LICENSE.md >`__ file for details
189188
190189Acknowledgments
191- ---------------
190+
192191
193192- Rotman School of Management, University of Toronto
194193 http://www.rotman.utoronto.ca/
@@ -201,17 +200,17 @@ Acknowledgments
201200- README conversion for PyPI. `Pandoc.org `_.
202201
203202Contributions
204- -------------
203+
205204
206205|contributions welcome |
207206
208207Disclaimer
209- ----------
208+
210209
211210All RIT software and external RIT links are provided by the Rotman School of Management and are their exclusive property.
212211
213- .. |Build Status | image :: https://app.travis-ci. com/SamSamhuns/ritpytrading. svg?branch=master
214- :target: https://app.travis-ci. com/SamSamhuns/ritpytrading
212+ .. |Build Status | image :: https://github. com/SamSamhuns/ritpytrading/actions/workflows/main.yaml/badge. svg
213+ :target: https://github. com/SamSamhuns/ritpytrading/actions/workflows/main.yaml
215214.. |Codacy Badge | image :: https://api.codacy.com/project/badge/Grade/6a873df3e02c4950add070885d3a4e8b
216215 :alt: Codacy Badge
217216 :target: https://app.codacy.com/gh/SamSamhuns/ritpytrading?utm_source=github.com&utm_medium=referral&utm_content=SamSamhuns/ritpytrading&utm_campaign=Badge_Grade_Settings
0 commit comments