|
1 |
| -<h2> 16807 Pious Academic, A Python Wrapper For H5</h2> |
2 |
| -<h3> Current Version: 1.0 </h3> |
| 1 | +<h2>16807 Pious Academic, A Python Wrapper For H5</h2> |
| 2 | +<h3>Current Version: 1.0 </h3> |
3 | 3 |
|
4 |
| -<h3> Version History </h3> |
| 4 | +<h3>Version History </h3> |
5 | 5 | <p><b>Future releases:</b> Additional tests to verify integrity, demo files.</p>
|
6 | 6 | <p><b>Version 1.0:</b> Cleaned up a few pieces of the code and added some documentation.</p>
|
7 | 7 | <p><b>Version 0.2:</b> Fixed all the major bugs and issues, added the rate limit and error classes to have a more operational program. Updated rate limits to support 343's new 1 request per second rate.</p>
|
8 | 8 | <p><b>Version 0.1:</b> First skeleton release, full of bugs and other fun stuff.</p>
|
| 9 | +<br> |
9 | 10 |
|
10 |
| -<h3> Installing Pious Academic </h3> |
| 11 | +<h3>Installing Pious Academic </h3> |
| 12 | +<p><a href="https://developer.haloapi.com/developer">Go here and sign into your microsoft account</a>, then go to your profile. You should have an API key ready for you to use. Get it, save it, and for the love of god don't let anyone other than yourself see it.</p> |
| 13 | +<p>The other prerequisite is to have the request module installed for Python. Run this in your terminal to install the module: |
| 14 | +<br> |
| 15 | +<br> |
| 16 | + $ pip install requests |
| 17 | +<br> |
| 18 | +<br> |
| 19 | +You can find the documentation for requests <a href="http://docs.python-requests.org/en/latest/">here</a>, but it isn't important if you're just using the wrapper, only if you want to <i>understand</i> how it works. |
| 20 | +</p> |
| 21 | +<br> |
| 22 | +<h3>Using Pious Academic </h3> |
| 23 | +<p>Using the module is fairly simple. Create your entry point main file and import the PiousAcademic class.</p> |
| 24 | + from PiousAcademic16807 import PiousAcademic |
| 25 | +<p>Then you'll need to define the PiousAcademic class as a variable</p> |
| 26 | + api = PiousAcademic() |
| 27 | +<p>Now you're free to manipulate any of the functions in the API as you see fit. Simply include whatever parameters you are required to include and any optional parameters you want to use.</p> |
| 28 | + |
11 | 29 |
|
12 |
| -<h3> Using Pious Academic </h3> |
13 |
| - |
14 |
| -<h3> Addendum </h3> |
| 30 | +<h3>Addendum </h3> |
| 31 | +<p>This wrapper was made for my use with <a href="www.bigteambattle.net">bigteambattle.net</a> website leaderboards and more. I'll keep everyone updated on when my project is complete if I can make it public for an example of utilising the wrapper. Feel free to contact me here or at my personal website, <a href="www.davidskudra.ca">davidskudra.ca</a> for any questions regarding this library or my work.</p> |
0 commit comments