-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathREADME
71 lines (58 loc) · 2.8 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
scratchapi2
A new Scratch API Client for Python 3+
Under GPLv3 or any later version
Copyright © 2018 apple502j, kenny2github All rights reversed.
(It's all right to say "reversed", it's GPL!)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Scratch is a project of the Lifelong Kindergarten Group at the MIT Media Lab.
Scratch is a trademark of the Lifelong Kindergarten Group at the MIT Media Lab.
The ScratchAPI2 Development Team is **NOT** a team of MIT, and none
of the member is on Scratch Team. Please remember that it's a hobby
and inofficial.
==== What is this?
It is a library for humans (and some robots). This library is a client
of Scratch API, so lots of features are available. But the development
team decided to remove all deprecated features.
It consists of some classes, such as:
* Misc (Information, Search, Statistics)
* Translate (Translate API)
* User (Scratch user)
* Project (Scratch project)
* FrontPage (Scratch Front Page API)
* Classroom (Scratch classroom)
* Comment
* Studio
and some classes just for developers...
==== Requirements
* Python 3.0+, should be 3.5+, tested on CPython 3.6.1
* Requests (should be the latest version)
==== For people who want to add a feature
The ScratchAPI2 Development Team needs help. See this for detail:
https://github.com/apple502j/scratchapi2/issues/2
1. Make sure the API exists! Test by YOURSELF.
2. If it needs CSRF token, make the code, PLEASE MAKE IT!
3. Please tell at least one reference. Available references:
* https://github.com/LLK/scratch-www (read the code)
* https://github.com/LLK/scratch-rest-api/wiki
* Scratch Wiki
==== Want to join?
Answer: Yes! But please make sure you're familiar with Python 3.x,
have GitHub account, and know about Scratch!
Needed Works:
* Pull Requests Reviewers
Nominate at https://github.com/apple502j/scratchapi2/issues/3 !
==== (By the way) Story
On June 9th, apple502j, the programmer on the team started making it.
When making, Kenny2scratch always helps. The great co-worker made this
library greater. For example, GenericData was made by him.
On July 4th, the library had a great update by him. His codes made this
library better and better.