Skip to main content

django-overcomingbias-api: an API to Robin Hanson's content

Project description

django-overcomingbias-api is a standalone Django app which lets you create and manage an API to (some of) Robin Hanson’s content.

It scrapes the overcomingbias blog (and other sites) and presents the data in a structured form via a REST API. (I may add a GraphQL API later, too.)

Basic Usage

A graphical user interface is provided through the Django admin site.

To initialise a database of all overcomingbias posts, use the “pull” button:

Create and update overcomingbias posts from the admin site

Add new posts with “pull”, and update modified posts with “sync”. (You can also add content from YouTube and Spotify.)

Categorise content according to the “ideas” and “topics” it contains, or by generic “tags”. Use the admin site and custom Admin Actions to manage content.

Link the app in your URL config to access the REST API:

# urls.py

urlpatterns = [
    ...
    path("", include("obapi.urls")),
    ...
]

You should then be able to access the automatic API documentation at URL /api/docs.

Alternatively, provide your own views for each post:

# urls.py
from django.urls import path, register_converter
from obapi.converters import OBPostNameConverter
from myapp.views import ob_detail_view

register_converter(OBPostNameConverter, "ob_name")
urlpatterns = [
    ...
    path(
        "content/overcomingbias/<ob_name:item_id>",
        ob_detail_view, # custom view
        name="obcontentitem_detail",
    ),
    ...
]

Features

Currently, content can be scraped from the following sources:

  • The overcomingbias blog (added automatically)

  • Robin Hanson’s home page

  • YouTube videos (add videos manually using their URLs)

  • Spotify podcast episodes (add episodes manually using their URLs)

Documentation

Read the full documentation here, including the Installation and Getting Started Guide.

Bugs/Requests

Please use the GitHub issue tracker to submit bugs or request features.

Changelog

See the Changelog for a list of fixes and enhancements at each version.

License

Copyright (c) 2022 Christopher McDonald

Distributed under the terms of the MIT license.

All overcomingbias posts are copyright the original authors.

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

django-overcomingbias-api-0.6.0.tar.gz (296.2 kB view details)

Uploaded Source

Built Distribution

django_overcomingbias_api-0.6.0-py3-none-any.whl (41.1 kB view details)

Uploaded Python 3

File details

Details for the file django-overcomingbias-api-0.6.0.tar.gz.

File metadata

File hashes

Hashes for django-overcomingbias-api-0.6.0.tar.gz
Algorithm Hash digest
SHA256 f63f808997001fbde19134160f3d3ff2881ce91441099df8e2fa7ba7135d1f3d
MD5 e1bee15d9d5d28d3f501b62c53809a1b
BLAKE2b-256 94edc6ac8e33ccf3a37a8990f061310c31d847f2825c7a35a602de53e78f8f32

See more details on using hashes here.

File details

Details for the file django_overcomingbias_api-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_overcomingbias_api-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 06cd412ad20ba8c38a22c699489ccf1fc33f864d3ae0064992bee164583fc45e
MD5 08d89ff0fae15e0afe1613062f036c14
BLAKE2b-256 b9fb437bd1f692f2501415a48a28f1e4cb4f2a6390f5244a539af3481dbc5665

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