https://github.com/marshalx/bluesky-feed-generator

🦋 Bluesky custom feed algorithms server in Python 🐍
https://github.com/marshalx/bluesky-feed-generator

atp atproto bluesky bluesky-feed bluesky-generator bsky custom-feed feed-generator

Last synced: 1 day ago
JSON representation

🦋 Bluesky custom feed algorithms server in Python 🐍

• Host: GitHub
• URL: https://github.com/marshalx/bluesky-feed-generator
• Owner: MarshalX
• License: mit
• Created: 2023-05-27T09:42:21.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-10T18:04:47.000Z (23 days ago)
• Last Synced: 2024-09-10T20:16:48.975Z (23 days ago)
• Topics: atp, atproto, bluesky, bluesky-feed, bluesky-generator, bsky, custom-feed, feed-generator
• Language: Python
• Homepage: https://atproto.blue
• Size: 53.7 KB
• Stars: 114
• Watchers: 7
• Forks: 28
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
## ATProto Feed Generator powered by [The AT Protocol SDK for Python](https://github.com/MarshalX/atproto)

> 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

### Getting Started

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 should be able to see your feed 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:

```shell

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:

```shell

flask run

```

Run development server with debug:

```shell

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