| Name | antonLib JSON |
| Version |
0.1.1.3.2
JSON |
| download |
| home_page | None |
| Summary | A library for interacting with the learning platform anton.app. |
| upload_time | 2024-03-23 19:48:09 |
| maintainer | None |
| docs_url | None |
| author | Antonabi |
| requires_python | >=3.7 |
| 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. |
| keywords |
antonapp
anton.app
anton
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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/").
Raw data
{
"_id": null,
"home_page": null,
"name": "antonLib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "antonapp, anton.app, anton",
"author": "Antonabi",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d7/fc/54a284be992a6f1a20dc02239222376114547bf8bd87e1c3e3e105a14ad1/antonLib-0.1.1.3.2.tar.gz",
"platform": null,
"description": "# antonLib\n\nantonLib is a python library created for interacting with the learning platform \"anton.app\".\n\n## Installing\n\nTo install antonLib simply type\n\n```bash\npip install antonLib\n```\n\ninto your command prompt.\n\nTo dwonload the source code you can just type this.\n\n```bash\ngit clone https://github.com/Antonabi/antonLib.git\n```\n\n### Requirements\n\nIf you downloaded the source code you have to install the requirements like this:\n\n```bash\npip install -r requirements.txt\n```\n\n## Usage\n\nWith antonLib you can make a lot of things. View the full documentation [here](\"https://github.com/Antonabi/antonLibDoc/\").\n\n### Examples\n\nHere ill list a few examples that show what the library does.\n\n#### Logging in\n\nThere are two different ways of logging in with antonLib. \nThe first one is the simplest:\n\n```python\nimport antonLib\n\nsession = antonLib.loginWithCode(\"yourLoginCode\") #creates a session object\n```\n\nFor the second one you need to have your logId:\n\n```python\nimport antonLib\n\nsession = antonLib.logInWithLogId(\"yourLogId\") #also creates a session object\n```\n\nIf you dont know what a logId is, [here](\"https://anotherDoclink.com\") is a description.\n\n#### Pixel Paint\n\nWhen you are logged in, you can do many things. Here is how you like a pixel paint image:\n\n```python\nimport antonLib\n\nsession = antonLib.loginWithCode(\"yourLoginCode\") #logging in\n\nsession.likePixelPaint(\"imageUid\") #liking the image\n```\n\nIf you dont know how to get the uid of an image, its actually quite simple. \nTo 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\".\n\n#### Creating Users\n\nWith antonLib you can also create users. Creating a user is very simple. This is an example script that does it:\n\n```python\nimport antonLib\n\ncreatedUser = antonLib.createUser(\"username\") #creating the user\n\nsession = 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)\n```\n\n#### Full Documentation\n\nCheck out the full documentation [here](\"https://github.com/Antonabi/antonLibDoc/\").\n",
"bugtrack_url": null,
"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.",
"summary": "A library for interacting with the learning platform anton.app.",
"version": "0.1.1.3.2",
"project_urls": {
"documentation": "https://github.com/Antonabi/antonLib/blob/main/documentation/start.md",
"repository": "https://github.com/Antonabi/antonLib/"
},
"split_keywords": [
"antonapp",
" anton.app",
" anton"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "97609d7ad641044eef2d3a8ffeb52407dfaa6a28dab1bc1f390b99ee48f38fb8",
"md5": "5a119d321e32b7c60d55b96eb3015576",
"sha256": "d90a1572b3178d6b366122a36035195bfa770dc311595805e15a610f56a2a7b6"
},
"downloads": -1,
"filename": "antonLib-0.1.1.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a119d321e32b7c60d55b96eb3015576",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10915,
"upload_time": "2024-03-23T19:48:08",
"upload_time_iso_8601": "2024-03-23T19:48:08.321117Z",
"url": "https://files.pythonhosted.org/packages/97/60/9d7ad641044eef2d3a8ffeb52407dfaa6a28dab1bc1f390b99ee48f38fb8/antonLib-0.1.1.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d7fc54a284be992a6f1a20dc02239222376114547bf8bd87e1c3e3e105a14ad1",
"md5": "04c22911fb3457c1d53b95a73cd1bd90",
"sha256": "d92543f466f9b8049c1696b963760ee60411e0616b5852ba0e8626a853268565"
},
"downloads": -1,
"filename": "antonLib-0.1.1.3.2.tar.gz",
"has_sig": false,
"md5_digest": "04c22911fb3457c1d53b95a73cd1bd90",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 10725,
"upload_time": "2024-03-23T19:48:09",
"upload_time_iso_8601": "2024-03-23T19:48:09.987775Z",
"url": "https://files.pythonhosted.org/packages/d7/fc/54a284be992a6f1a20dc02239222376114547bf8bd87e1c3e3e105a14ad1/antonLib-0.1.1.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-23 19:48:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Antonabi",
"github_project": "antonLib",
"github_not_found": true,
"lcname": "antonlib"
}
