Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/konradit/parler-py-api
UNOFFICIAL Python API to interface with Parler.com
https://github.com/konradit/parler-py-api
disinformation parler research
Last synced: 7 days ago
JSON representation
UNOFFICIAL Python API to interface with Parler.com
- Host: GitHub
- URL: https://github.com/konradit/parler-py-api
- Owner: KonradIT
- Created: 2020-07-19T21:19:03.000Z (over 4 years ago)
- Default Branch: v2
- Last Pushed: 2024-07-23T19:01:31.000Z (6 months ago)
- Last Synced: 2025-01-12T23:07:31.903Z (14 days ago)
- Topics: disinformation, parler, research
- Language: Python
- Homepage:
- Size: 118 KB
- Stars: 54
- Watchers: 9
- Forks: 14
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Parler API interface for Python
This **UNOFFICIAL** library designed to programatically fetch data from parler.com
# IMPORTANT ANNOUNCEMENT:
~~This library supports the new (as of 2022-02-06) Parler `open-api` / logged-in endpoints. Both logged in and guest modes are supported.~~
**Show is back on!** Now this library supports the *even newer* (as of 2022-10-21) Parler `/v0/` and `/v0/public` endpoints. Same caveats, both logged in and guest modes are supported
# To do list:
- [X] Implement unfinished authed functions
- [ ] Rework experiments
- [ ] Have a github action (several!) to archive posts, run analysises, etc..
- [ ] Implement controls for header `x-ratelimit-limit` and `x-ratelimit-limit-remaining`
- [X] Testing, testing
- [X] Publish to pypi
## Authentication:
There are two modes of using the API. **Authenticated** and **Guest**.
Authentication is done by initializing the `Parler` class, importing `Parler.with_auth` and initializing an `AuthSession` with your credentials.
```python
from Parler import with_auth as authed
au = authed.AuthSession(debug=False)
au.is_logged_in # ==> False
au.login(
identifier=os.getenv("email"),
password=os.getenv("password")
)
au.is_logged_in # ==> True
```
Here is a chart of how the functions are "loginwalled" or not.
| Function | Description | API Type needed |
|--------------------|----------------------------------------------------------------------------------------|-----------------|
| `.profile()` | Get information from a specified username | Guest |
| `.user_feed()` | Get Parleys and echoes from a specified username | Guest |
| `.trending()` | Get trending people | Guest |
| `.feed()` | Get feed | Authenticated |
| `.users()` | Search for users | Authenticated |
| `.hashtags()` | Search for hashtags | Authenticated |
| `.following()` | Get following profiles from specified username | Authenticated |
| `.comments()` | Get comments from a specified post ID | Authenticated |
## Installation
#### From pypi:
```
pip install parler-api
```
#### Clone and run locally:
If using `pipenv`:
```
pipenv install
pipenv shell
```
If using `pip`:
```
pip install -r requirements.txt
```
## Experiments:
Collected the suggested hashtags for a 9 hour period, [data here](./sampledata/hashtags.csv)
Other experiments available as well.
## Contributing:
Feel free to improve the code, submit your experiments and sample code or fix bugs. Before submitting a PR, run `pep8` linter on your code.
## Donate:
If you found this package useful, [consider donating](https://paypal.me/konradit).
## Disclaimer:
I am in now way affiliated with Parler, it's subsidiaries or any entity related to the company. I am not responsible for what you do with this Python package.
2009/24/EC Art 5:
```
The person having a right to use a copy of a computer program shall be entitled, without the authorisation of the rightholder, to observe, study or test the functioning of the program in order to determine the ideas and principles which underlie any element of the program if he does so while performing any of the acts of loading, displaying, running, transmitting or storing the program which he is entitled to do.
```