Skip to main content

A Python package for accessing the LemmyHttp API

Project description

Pythonlemmy: a Python package for accessing the Lemmy API

drawing

GitHub version PyPI version GitHub license

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.1.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

pythonlemmy-0.1.1-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

File details

Details for the file pythonlemmy-0.1.1.tar.gz.

File metadata

  • Download URL: pythonlemmy-0.1.1.tar.gz
  • Upload date:
  • Size: 26.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for pythonlemmy-0.1.1.tar.gz
Algorithm Hash digest
SHA256 41d7baad98bfb61e637cafceb059fc141c71c8e44128cf827d9db9960038e517
MD5 c3187147efcbc6eacd24597d706fb045
BLAKE2b-256 c0690d8538e50b39479cbfd20e0883cbbcceff8fd43ac1499cb18a7b9527f187

See more details on using hashes here.

File details

Details for the file pythonlemmy-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pythonlemmy-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 31.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for pythonlemmy-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7e732aeffdb289ceebc8652c2a2337a166fb4c4e7b1c9b1c36f085b97c5012b4
MD5 1761b339848e870b6056c2b6dc8d62e7
BLAKE2b-256 7ee001b46c1937c62a80bc93635938733f63a4cb65a95137ee1b1256906c6642

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page