Metadata-Version: 2.1
Name: ConnectWrapper
Version: 0.0.2
Summary: A easy-to-use wrapper for connect.det.wa.edu.au implemented in Python3
Home-page: https://github.com/Mitch0S/ConnectWrapper
Author: Mitch Naake
Author-email: mitchnaake@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/Mitch0S/ConnectWrapper/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# ConnectWrapper
Written by Mitch Naake (Year 11 ATAR Computer Science, Butler College)

### _What is ConnectWrapper?_  
ConnectWrapper is an easy way for Western-Australian students to create their own apps around the teacher-student communication platform, https://connect.det.wa.edu.au/  


### _What are the benefits?_
ConnectWrapper handles all requests and responses to and from the Connect webserver. Responses from the webserver are parsed and compiled in a way that makes it easier to get information from your request, saving you endless time with trying to find specific data from your own request, it's all there in front of you, in an easy-to-read format!  


### _What can I do with ConnectWrapper?_
Upon it's initial release, ConnectWrapper has the following functions, based around the mobile API for ConnectNow, Connect's mobile app:
- Authentication
  - GET `token` (Used for authenticating future requests)
  - CHECK `token` (Used to check whether a `token` is valid/invalid/expired)
  

- Notices
  - GET `notice_feed` (Returns posts depending on user's kwargs, default returns the 10 most-recent posts)
  - GET `notice` (Used to view the details about the notice, adds a view to notice view counter)
  - POST `notice_comment` (Posts a comment to the specified `notice`)

*Please Note: There are more functions coming soon...*


