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:
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django_overcomingbias_api-0.6.3.tar.gz
.
File metadata
- Download URL: django_overcomingbias_api-0.6.3.tar.gz
- Upload date:
- Size: 292.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5a81aef5362fa8a248e3d536750d5b6e8b2ff494aff3245e0ce9779b1d36b4c |
|
MD5 | c11bd74e90fe058090152a89b1b94a59 |
|
BLAKE2b-256 | 0c4e8e4947df854bc3e8d7be18a2fdc5999abfbc6c0ab858402fa0dfc8b5cc07 |
File details
Details for the file django_overcomingbias_api-0.6.3-py3-none-any.whl
.
File metadata
- Download URL: django_overcomingbias_api-0.6.3-py3-none-any.whl
- Upload date:
- Size: 41.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00ac709ed1fb3e17e80c833bc5c8111f685844d3e97d0615911f55a57d9a2c8a |
|
MD5 | 8e8a1b2dfd7fc81c9924491f5c6fa6a4 |
|
BLAKE2b-256 | a1feb22466aa4019d8972cbe021bc3b823e4ff59b6ea7bd0a03fb76249f0a35b |