Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hfaran/piazza-api
Unofficial Client for Piazza's Internal API
https://github.com/hfaran/piazza-api
api-client piazza piazza-api python
Last synced: about 17 hours ago
JSON representation
Unofficial Client for Piazza's Internal API
- Host: GitHub
- URL: https://github.com/hfaran/piazza-api
- Owner: hfaran
- License: mit
- Created: 2013-12-12T08:20:26.000Z (about 11 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-22T01:52:45.000Z (2 months ago)
- Last Synced: 2024-12-21T07:04:58.603Z (8 days ago)
- Topics: api-client, piazza, piazza-api, python
- Language: Python
- Homepage: https://hfaran.github.io/posts/reverse-engineering-piazzas-api/
- Size: 149 KB
- Stars: 188
- Watchers: 11
- Forks: 55
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# piazza-api
[](http://badge.fury.io/py/piazza-api)
Unofficial Client for Piazza's Internal API
## Usage
```python
>>> from piazza_api import Piazza
>>> p = Piazza()
>>> p.user_login()
Email: ...
Password: ...
>>> user_profile = p.get_user_profile()
>>> eece210 = p.network("hl5qm84dl4t3x2")
>>> eece210.get_post(100)
...
>>> posts = eece210.iter_all_posts(limit=10)
>>> for post in posts:
... do_awesome_thing(post)
>>> users = eece210.get_users(["userid1", "userid2"])
>>> all_users = eece210.get_all_users()
```
Above are some examples to get started; more in the documentation (which is coming soon;
but the code is all Sphinx-style documented and is fairly readable).
You can also use the "internal" PiazzaRPC class which maps more directly
to Piazza's API itself but is not as nice and as intuitive to use as the
`Piazza` class abstraction.
```python
>>> from piazza_api.rpc import PiazzaRPC
>>> p = PiazzaRPC("hl5qm84dl4t3x2")
>>> p.user_login()
Email: ...
Password: ...
>>> p.content_get(181)
...
>>> p.add_students(["[email protected]", "[email protected]"])
...
```
## Installation
You've seen this before and you'll see it again.
```bash
# The easy way
pip install piazza-api
```
```bash
# The developer way
git clone https://github.com/hfaran/piazza-api
cd piazza-api
python setup.py develop
```
```bash
# The Docker way
git clone https://github.com/hfaran/piazza-api
cd piazza-api
docker build -t piazza-api .
docker run -it piazza-api:latest
```
## Contribute
* [Issue Tracker](https://github.com/hfaran/piazza-api/issues)
* [Source Code](https://github.com/hfaran/piazza-api)
## License
This project is licensed under the MIT License.
## Disclaimer
This is not an official API. I am not affiliated with Piazza Technologies Inc.
in any way, and am not responsible for any damage that could be done with it.
Use it at your own risk.