| Name | django-overcomingbias-api JSON |
| Version |
0.6.3
JSON |
| download |
| home_page | |
| Summary | django-overcomingbias-api: an API to Robin Hanson's content |
| upload_time | 2023-02-06 17:25:59 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| 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. |
| keywords |
api
django
overcomingbias
scrape
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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.
Raw data
{
"_id": null,
"home_page": "",
"name": "django-overcomingbias-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "api,django,overcomingbias,scrape",
"author": "",
"author_email": "Christopher McDonald <cmcdonal33@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0c/4e/8e4947df854bc3e8d7be18a2fdc5999abfbc6c0ab858402fa0dfc8b5cc07/django_overcomingbias_api-0.6.3.tar.gz",
"platform": null,
"description": "django-overcomingbias-api: an API to Robin Hanson's content\n===========================================================\n\n``django-overcomingbias-api`` is a standalone `Django <https://www.djangoproject.com/>`_\napp which lets you create and manage an API to (some of) Robin Hanson's content.\n\nIt scrapes the `overcomingbias <https://www.overcomingbias.com/>`_ blog (and other\nsites) and presents the data in a structured form via a\n`REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`_ API.\n(I may add a GraphQL API later, too.)\n\nBasic Usage\n-----------\n\nA graphical user interface is provided through the\n`Django admin site <https://docs.djangoproject.com/en/dev/ref/contrib/admin/>`_.\n\nTo initialise a database of all overcomingbias posts, use the \"pull\" button:\n\n.. image:: https://raw.githubusercontent.com/chris-mcdo/django-overcomingbias-api/main/docs/source/_static/pull-and-sync.png\n :align: center\n :alt: Create and update overcomingbias posts from the admin site\n\nAdd new posts with \"pull\", and update modified posts with \"sync\".\n(You can also add content from YouTube and Spotify.)\n\nCategorise content according to the \"ideas\" and \"topics\" it contains, or by generic\n\"tags\".\nUse the admin site and custom\n`Admin Actions <https://docs.djangoproject.com/en/dev/ref/contrib/admin/actions/>`_\nto manage content.\n\nLink the app in your URL config to access the REST API:\n\n.. code-block:: python\n\n # urls.py\n\n urlpatterns = [\n ...\n path(\"\", include(\"obapi.urls\")),\n ...\n ]\n\n\nYou should then be able to access the automatic API documentation at URL ``/api/docs``.\n\nAlternatively, provide your own views for each post:\n\n.. code-block:: python\n\n # urls.py\n from django.urls import path, register_converter\n from obapi.converters import OBPostNameConverter\n from myapp.views import ob_detail_view\n\n register_converter(OBPostNameConverter, \"ob_name\")\n urlpatterns = [\n ...\n path(\n \"content/overcomingbias/<ob_name:item_id>\",\n ob_detail_view, # custom view\n name=\"obcontentitem_detail\",\n ),\n ...\n ]\n\nFeatures\n--------\n\nCurrently, content can be scraped from the following sources:\n\n- The `overcomingbias <https://www.overcomingbias.com/>`_ blog (added automatically)\n\n- Robin Hanson's `home page <https://mason.gmu.edu/~rhanson/>`_\n\n- YouTube videos (add videos manually using their URLs)\n\n- Spotify podcast episodes (add episodes manually using their URLs)\n\nDocumentation\n-------------\n\nRead the full documentation `here <https://django-overcomingbias-api.readthedocs.io/en/stable/>`_,\nincluding the `Installation and Getting Started Guide\n<https://django-overcomingbias-api.readthedocs.io/en/stable/getting-started.html>`_.\n\n\nBugs/Requests\n-------------\n\nPlease use the\n`GitHub issue tracker <https://github.com/chris-mcdo/django-overcomingbias-api/issues>`_\nto submit bugs or request features.\n\nChangelog\n---------\n\nSee the\n`Changelog <https://django-overcomingbias-api.readthedocs.io/en/stable/changelog.html>`_\nfor a list of fixes and enhancements at each version.\n\nLicense\n-------\n\nCopyright (c) 2022 Christopher McDonald\n\nDistributed under the terms of the\n`MIT <https://github.com/chris-mcdo/django-overcomingbias-api/blob/main/LICENSE>`_\nlicense.\n\nAll overcomingbias posts are copyright the original authors.\n",
"bugtrack_url": null,
"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.",
"summary": "django-overcomingbias-api: an API to Robin Hanson's content",
"version": "0.6.3",
"split_keywords": [
"api",
"django",
"overcomingbias",
"scrape"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1feb22466aa4019d8972cbe021bc3b823e4ff59b6ea7bd0a03fb76249f0a35b",
"md5": "8e8a1b2dfd7fc81c9924491f5c6fa6a4",
"sha256": "00ac709ed1fb3e17e80c833bc5c8111f685844d3e97d0615911f55a57d9a2c8a"
},
"downloads": -1,
"filename": "django_overcomingbias_api-0.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e8a1b2dfd7fc81c9924491f5c6fa6a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 41560,
"upload_time": "2023-02-06T17:25:58",
"upload_time_iso_8601": "2023-02-06T17:25:58.068408Z",
"url": "https://files.pythonhosted.org/packages/a1/fe/b22466aa4019d8972cbe021bc3b823e4ff59b6ea7bd0a03fb76249f0a35b/django_overcomingbias_api-0.6.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c4e8e4947df854bc3e8d7be18a2fdc5999abfbc6c0ab858402fa0dfc8b5cc07",
"md5": "c11bd74e90fe058090152a89b1b94a59",
"sha256": "e5a81aef5362fa8a248e3d536750d5b6e8b2ff494aff3245e0ce9779b1d36b4c"
},
"downloads": -1,
"filename": "django_overcomingbias_api-0.6.3.tar.gz",
"has_sig": false,
"md5_digest": "c11bd74e90fe058090152a89b1b94a59",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 291952,
"upload_time": "2023-02-06T17:25:59",
"upload_time_iso_8601": "2023-02-06T17:25:59.644969Z",
"url": "https://files.pythonhosted.org/packages/0c/4e/8e4947df854bc3e8d7be18a2fdc5999abfbc6c0ab858402fa0dfc8b5cc07/django_overcomingbias_api-0.6.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-06 17:25:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "django-overcomingbias-api"
}
