projectdelphai / karzetek

A python API that gives rss recommendations based on a url or rss feed.

Karzetek

Reuben Castelino - [email protected]

Description

Karzetek is an anglicized name of Karze\u0142ek, a Polish myth about diminutive dwarfs who live in mines, protect miners, and guard precious jewels.

Karzetek is a python API that searches through a feed or url for external hyperlinks. It finds any rss feeds associated with those hyperlinks and returns them as a json string. The logic behind karzetek is that if A likes B enough to link to it and you like A then you might like B as well.

Installation

If you want to install this service for personal use:

1. pip install feedparser beautifulsoup4 Flask
2. git clone https://github.com/projectdelphai/karzetek.git
3. python index.py

It is recommended that you install this all under a virtualenv folder.

You will also need some sort of postgres database.

Using the API

The API itself is hosted on karzetek.heroku.com. To get recommendations, the format is as follows:

karzetek.heroku.com?feed=FEED_URL

The feed url should not be enclosed in quotes.

The process is currently pretty slow and you should recieve the json in about 15 seconds. However, it does have caching, so the more karzetek is used the more likely your response will be 4-6 seconds.

Using Karzetek

Within this repo, index.py handles the online API service. The actual code dealing with finding recommendations is isolated to the karzetek.py file.

To use it:

from karzetek import Karzetek
karzetek = Karzetek()

to get recommendations from a url:

recommendations = karzetek.url_recommendations(url) 

to get recommendations from a feed url:

recommendations = karzetek.feed_recommendations(feed_url)

Helping Out

To help out:

1. Fork repo
2. Make changes
3. Change documentation to reflect your changes
4. Make a pull request

Todo

More help is always welcome. Here are some outlined goals:

1. More documentation - Always needed
2. Speed up searching - Always, database caching may help here
3. Tests - I don't know how to do this personally.
4. Database caching - Working on it now
5. Maybe a wiki? - Not a big enough project yet though.
6. Integrate with Tiny Tiny RSS - longer term goal

Version

0.0.2-1 refactored removed duplicated recommendations

0.0.2 added basic database records

0.0.1

• Initial Commit