Metadata-Version: 2.1
Name: antonLib
Version: 0.1.1.2
Summary: A library for interacting with the learning platform anton.app.
Author: Antonabi
License: MIT License
        
        Copyright (c) 2024 Antonabi
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: repository, https://github.com/Antonabi/antonLib/
Project-URL: documentation, https://github.com/Antonabi/antonLib/blob/main/documentation/start.md
Keywords: antonapp,anton.app,anton
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: certifi
Requires-Dist: charset-normalizer
Requires-Dist: idna
Requires-Dist: requests
Requires-Dist: urllib3
Provides-Extra: build
Requires-Dist: build ; extra == 'build'
Requires-Dist: twine ; extra == 'build'
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: bumpver ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'

# antonLib

antonLib is a python library created for interacting with the learning platform "anton.app".

## Installing

To install antonLib simply type

```bash
pip install antonLib
```

into your command prompt.

To dwonload the source code you can just type this.

```bash
git clone https://github.com/Antonabi/antonLib.git
```

### Requirements

If you downloaded the source code you have to install the requirements like this:

```bash
pip install -r requirements.txt
```

## Usage

With antonLib you can make a lot of things. View the full documentation [here]("https://github.com/Antonabi/antonLibDoc/").

### Examples

Here ill list a few examples that show what the library does.

#### Logging in

There are two different ways of logging in with antonLib.  
The first one is the simplest:

```python
import antonLib

session = antonLib.loginWithCode("yourLoginCode") #creates a session object
```

For the second one you need to have your logId:

```python
import antonLib

session = antonLib.logInWithLogId("yourLogId") #also creates a session object
```

If you dont know what a logId is, [here]("https://anotherDoclink.com") is a description.

#### Pixel Paint

When you are logged in, you can do many things. Here is how you like a pixel paint image:

```python
import antonLib

session = antonLib.loginWithCode("yourLoginCode") #logging in

session.likePixelPaint("imageUid") #liking the image
```

If you dont know how to get the uid of an image, its actually quite simple.  
To get it, you just need to click on the image, and then click on "share image". Then you will get a link that looks like this: `https://anton.app/pixelPaintImage/RqfT06Mp`. The uid is at the end of the link. In this example it is "RqfT06Mp".

#### Creating Users

With antonLib you can also create users. Creating a user is very simple. This is an example script that does it:

```python
import antonLib

createdUser = antonLib.createUser("username") #creating the user

session = antonLib.logInWithLogId(createdUser.logId) #logging in (you have to log in with the logId because a created user object doesnt give you a login code)
```

#### Full Documentation

Check out the full documentation [here]("https://github.com/Antonabi/antonLibDoc/").
