Metadata-Version: 2.1
Name: django-overcomingbias-api
Version: 0.6.1
Summary: django-overcomingbias-api: an API to Robin Hanson's content
Project-URL: repository, https://github.com/chris-mcdo/django-overcomingbias-api
Project-URL: issues, https://github.com/chris-mcdo/django-overcomingbias-api/issues
Project-URL: documentation, https://django-overcomingbias-api.readthedocs.io/en/stable
Project-URL: changelog, https://django-overcomingbias-api.readthedocs.io/en/stable/changelog.html
Author-email: Christopher McDonald <cmcdonal33@gmail.com>
License: MIT License
        
        Copyright (c) 2022 Christopher McDonald
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: api,django,overcomingbias,scrape
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Requires-Python: >=3.8
Requires-Dist: bleach>=5.0.0
Requires-Dist: django-model-utils>=4.2.0
Requires-Dist: django-ninja
Requires-Dist: django-ordered-model>=3.5
Requires-Dist: django<5.0,>=4.0
Requires-Dist: obscraper
Requires-Dist: pandadoc
Requires-Dist: python-dateutil>=2.7
Requires-Dist: python-slugify>=5.0
Provides-Extra: test
Requires-Dist: pytest-django>=4.5.0; extra == 'test'
Requires-Dist: pytest>=6.2.5; extra == 'test'
Requires-Dist: python-dotenv>=0.20.0; extra == 'test'
Description-Content-Type: text/x-rst

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

``django-overcomingbias-api`` is a standalone `Django <https://www.djangoproject.com/>`_
app which lets you create and manage an API to (some of) Robin Hanson's content.

It scrapes the `overcomingbias <https://www.overcomingbias.com/>`_ blog (and other
sites) and presents the data in a structured form via a
`REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`_ API.
(I may add a GraphQL API later, too.)

Basic Usage
-----------

A graphical user interface is provided through the
`Django admin site <https://docs.djangoproject.com/en/dev/ref/contrib/admin/>`_.

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

.. image:: https://raw.githubusercontent.com/chris-mcdo/django-overcomingbias-api/main/docs/source/_static/pull-and-sync.png
   :align: center
   :alt: 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 <https://docs.djangoproject.com/en/dev/ref/contrib/admin/actions/>`_
to manage content.

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

.. code-block:: python

    # 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:

.. code-block:: python

    # 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 <https://www.overcomingbias.com/>`_ blog (added automatically)

- Robin Hanson's `home page <https://mason.gmu.edu/~rhanson/>`_

- YouTube videos (add videos manually using their URLs)

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

Documentation
-------------

Read the full documentation `here <https://django-overcomingbias-api.readthedocs.io/en/stable/>`_,
including the `Installation and Getting Started Guide
<https://django-overcomingbias-api.readthedocs.io/en/stable/getting-started.html>`_.


Bugs/Requests
-------------

Please use the
`GitHub issue tracker <https://github.com/chris-mcdo/django-overcomingbias-api/issues>`_
to submit bugs or request features.

Changelog
---------

See the
`Changelog <https://django-overcomingbias-api.readthedocs.io/en/stable/changelog.html>`_
for a list of fixes and enhancements at each version.

License
-------

Copyright (c) 2022 Christopher McDonald

Distributed under the terms of the
`MIT <https://github.com/chris-mcdo/django-overcomingbias-api/blob/main/LICENSE>`_
license.

All overcomingbias posts are copyright the original authors.
