ATProto Feed Generator powered by The AT Protocol SDK for Python

Feed Generators are services that provide custom algorithms to users through the AT Protocol.

Official overview(read it first): https://github.com/bluesky-social/feed-generator#overview

Feed example: https://bsky.app/profile/did:plc:kvwvcn5iqfooopmyzvb4qzba/feed/whats-alf

Getting

We've set up this simple server with SQLite to store and query data. Feel free to switch this out for whichever database you prefer

Next, you will need to do two things:

1. Implement indexing logic in server/data_filter.py.
2. Implement feed generation logic in server/algos.

We've taken care of setting this server up with a did:web. However, you're free to switch this out for did:plc if you like - you may want to if you expect this Feed Generator to be long-standing and possibly migrating domains.

Publishing your feed

To publish your feed, go to the script at publish_feed.py and fill in the variables at the top. Examples are included, and some are optional. To publish your feed generator, simply run python publish_feed.py.

To update your feed's display data (name, avatar, description, etc.), just update the relevant variables and re-run the script.

After successfully running the script, you will notice that your feed is visible from within the app, as well as share it by embedding a link in a post (similar to a quote post).

Running the Server

Install Python 3.7+, optionally create virtual environment.

Install dependencies:

pip install -r requirements.txt

Copy .env.example as .env. Fill the variables.

Note To get value for "WHATS_ALF_URI" you should publish the feed first.

Run development flask server:

flask run

Run development server with debug:

flask --debug run

Note Duplication of data stream instances in debug mode is fine. Read warn below.

Warning In production, you should use production WSGI server instead.

Warning If you want to run server in many workers, you should run Data Stream (Firehose) separately.

Endpoints:

• /.well-known/did.json
• /xrpc/app.bsky.feed.describeFeedGenerator
• /xrpc/app.bsky.feed.getFeedSkeleton

License

MIT