Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #29

Merged
merged 1 commit into from
Aug 16, 2024
Merged

Update README.md #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 2 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,5 @@ An Magis API written with and for python
[![Python package](https://github.com/StoppedwummPython/pygis/actions/workflows/python-package.yml/badge.svg)](https://github.com/StoppedwummPython/pygis/actions/workflows/python-package.yml)


## Installation

Obtain the files to the API, then move it to your project

```python
import pygis
```

## Functions
### Login
Log into the session with
```python
import pygis
ms = pygis.magisSession(frontend, backend, webdav)
ms.login(username, pwd)
```

`ms.login` will return an `user` object.

### Obtain Infos
You can obtain your courses with `.getCourses()`.

`.getApps` returns all Apps.

`.getUsers` returns all Users.
## Quickstart
<https://stoppedwummpython.github.io/pygis/quickstart/>
Loading