[](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(["student@example.com", "anotherStudent@example.com"])
...
```
## 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
```
## Contribute
* [Issue Tracker](https://github.com/hfaran/piazza-api/issues)
* [Source Code](https://github.com/hfaran/piazza-api)
### Commit Message Guidelines
Commit messages should be written with the following style: `%{type}(%{scope}): %{description}`.
* Valid `type`s are
- `feat`
- `fix`
- `docs`
- `style`
- `refactor`
- `perf`
- `test`
- `revert`
* Valid `scope`s are
- `dev` (if the change is irrevelant to the user or otherwise has no impact on the top-level API and only to developers)
- `user` (if this commit is a change that affects the top-level user-facing interface)
* `description` is the actual commit message
## 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.
1 maintainer
Metadata
1 maintainer
Release files for piazza-api 0.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| piazza-api-0.5.1.tar.gz | 8.5 kB | Without provenance | Details |
Release files / piazza-api-0.5.1.tar.gz
| Download URL | piazza-api-0.5.1.tar.gz |
|---|---|
| Size | 8.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e8944db0bd10c5e5b09ba7f0608a1c1ca31b1b4c051a5ac0f72abd7f98f6f57b
|
|
BLAKE2b-256 checksum How to use checksums |
8ab6b6504fc787c499ac5593658d5884fd975f08f74a6f00ded28f82cc93e4ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for piazza-api 0.5.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
