A Python package for accessing the LemmyHttp API
Project description
Pythonlemmy: a Python package for accessing the Lemmy API
Pythonlemmy allows you to interact with any Lemmy instance using Python and the LemmyHttp API.
WARNING: Pythonlemmy is still in development and needs testing!
Installation
A PyPI repository is updated whenever a new version is available:
python -m pip install pythonlemmy
Basic usage
Interact with a Lemmy instance using the LemmyHttp object:
from pythonlemmy import LemmyHttp
# create object for Lemmy.world, log in
srv = LemmyHttp("https://lemmy.world")
srv.login("<username_or_email>", "<password>")
Access specific communities:
from pythonlemmy.responses import GetCommunityResponse
# obtain community, parse JSON
api_response = srv.get_community(name="Lemmy")
response = GetCommunityResponse(api_response)
# community info
community = response.community_view.community
print(community.name)
print(community.actor_id)
print(community.id)
# list community moderators
for person in response.moderators:
print(person.moderator.name, person.community.name)
Create a post:
from pythonlemmy.responses import PostResponse
# create post, parse JSON
api_response = srv.create_post(community.id, "Test post please ignore", "Body text")
response = PostResponse(api_response)
# post info
post = response.post_view.post
print(post.creator_id)
print(post.community_id)
print(post.name)
print(post.body)
Full documentation is on its way, but in the meantime check out our source code and some examples.
Reporting issues, making contributions, etc.
Don't hesitate to report a bug or unexpected results! Want to contribute? Make a pull request. Contact @tjkessler with any questions.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pythonlemmy-0.1.2.tar.gz
(26.6 kB
view hashes)
Built Distribution
Close
Hashes for pythonlemmy-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3b6f5a1730ce580b620b6a3e07021c48be47943450e4b53f3cfcec21bd5a15a |
|
MD5 | ad801b3079b1eaa0ea5963cb69b5fbeb |
|
BLAKE2b-256 | e6618340abbf974994451f816a8c1939f61d12f91d6461c62993a029e4ba15a2 |