' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/genindex.html b/genindex.html new file mode 100644 index 0000000..d24b0ad --- /dev/null +++ b/genindex.html @@ -0,0 +1,181 @@ + + + + + +| + | + |
| + |
| + |
| + |
|
+
|
+ + |
Contents:
+ +Python wrapper and APIs for the PESU Academy website.
+The wrapper requires the user’s credentials to authenticate and provide read-only access to all the pages and +information accessible on the PESU Academy website. Without the credentials, the wrapper will only be able to fetch +details from the Know Your Class and Section page.
+Warning: This is not an official API and is not endorsed by PESU. Use at your own risk.
+pip install pesuacademy
+git clone https://github.com/HackerSpace-PESU/pesuacademy-py
+cd pesuacademy-py
+python setup.py install
+from pesuacademy import PESUAcademy
+p = PESUAcademy("PRN_or_SRN", "password")
+profile = p.profile()
+courses = p.courses(semester=2)
+attendance = p.attendance()
+Bases: object
A class to interact with PESU Academy website. +This class is the entrypoint to all the functionality in this module
+Get the attendance in courses of the currently authenticated user.
+semester – The semester number. If not provided, attendance across all semesters are returned.
+The attendance information for the given semester.
+Get the courses of the currently authenticated user.
+semester – The semester number. If not provided, all courses across all semesters are returned.
+The course information for the given semester.
+Generate a CSRF token. If username and password are provided, authenticate and get the CSRF token.
+username – Your SRN, PRN or email address.
password – Your password.
The CSRF token.
+Get the publicly visible class and section information of a student from the Know Your Class and Section page.
+username – The SRN, PRN or email address of the student.
+The profile information.
+Get the private profile information of the currently authenticated user.
+The profile information.
+| + p | ||
| + |
+ pesuacademy | + |
| + |
+ pesuacademy.pesuacademy | + |
