lobstr 0.5.0

unofficial API client for lobste.rs

lobstr

lobstr is an unofficial async-first object-oriented api wrapper for lobste.rs.

the library only supports GET requests or read operations. It plans to support the following objects

• feeds (homepage, newest, by tags, etc)
• stories (the post + comments)
• comments (info about a singular comment)
• tags (info regarding a tag, list of all tags)
• search (search for stories, comments, users)

Table of Contents

• Features
• Installation
• Quick Start
• Documentation
• License

Features

• Async-first API built on httpx
• Fully typed Pydantic models
• Well-documented sdk with docstrings

Installation

Requires Python 3.10 or higher.

pip

pip install lobstr

uv

uv add lobstr

Poetry

poetry add lobstr

Pipenv

pipenv install lobstr

Quick Start

Fetch a Story

import asyncio
from lobstr import Lobster

async def main():
    async with Lobster() as lob:
        story = await lob.story(short_id="ishgbs")
        print(story.title) # title of the story
        print(story.username) # author's username
        print(story.article_url) # article attached to the story

asyncio.run(main())

Fetch Hottest Stories

import asyncio
from lobstr import Lobster

async def main():
    async with Lobster() as lob:
        stories = await lob.feeds.hot()
        for story in stories[:5]: # print the top 5 hottest stories
            print(story.title) # title of the story
            print(story.username) # author's username
            print(story.article_url) # article attached to the story

asyncio.run(main())

Documentation

Complete documentation, API reference, guides, and examples are available at:

https://kavin81.github.io/lobstr

For lobste.rs API documentation, API_SPEC.md.

License

• MIT