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

Uploaded Source

Built Distribution

pythonlemmy-0.1.3-py3-none-any.whl (32.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pythonlemmy-0.1.3.tar.gz
  • Upload date:
  • Size: 26.7 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.3.tar.gz
Algorithm Hash digest
SHA256 a8cea092f84449d1f1109c87a79582c9c970bd362105bfa9d3b07782d48050c9
MD5 cd91a516ba4c11e1337408cfbd67ddfb
BLAKE2b-256 6a959961ecceac0001ac3b2b2d6f7a546c4fb795556904f55b979cab373d641f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pythonlemmy-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 32.1 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9af2ec18547545e9fb296dfeafee7e8f6386f506ad70f541696e2b0e21de40be
MD5 5c3242abec43d4a3067cd042df01679b
BLAKE2b-256 b7b9ba209da23ef3061ff00d0e7b552aa3cc9400fd4bbdbe8c9faf6e2a595a84

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