| Name | django-overcomingbias-pages JSON |
| Version |
0.7.4
JSON |
| download |
| home_page | |
| Summary | django app web interface to Robin Hanson's content |
| upload_time | 2023-02-06 17:28:13 |
| 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 |
content
django
overcomingbias
scrape
website
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
django-overcomingbias-pages: a web interface to Robin Hanson's content
======================================================================
``django-overcomingbias-pages`` is a standalone `Django <https://www.djangoproject.com/>`_
app which provides a web interface to Robin Hanson's content.
Features
--------
The main features are:
- Scrape content from across the web (`overcomingbias <https://overcomingbias.com/>`_,
`YouTube <https://www.youtube.com/>`_, `Spotify <https://spotify.com/>`_
and more) via the admin site.
- Search content with `meilisearch <https://www.meilisearch.com/>`_.
- Create sequences (series) of content and export them to PDF, epub, plaintext,
or any other format supported by `pandoc <https://pandoc.org/>`_.
- Persistent user accounts.
Configuration
-------------
To configure ``django-overcomingbias-pages``, add the following to your settings:
.. code-block:: python
# settings.py
# add required apps
INSTALLED_APPS = [
# required for admin site / user accounts
"django.contrib.admin",
"django.contrib.auth",
"django.contrib.contenttypes",
"django.contrib.sessions",
"django.contrib.messages",
# for collecting static files
"django.contrib.staticfiles",
# django-overcomingbias-api
"ordered_model",
"obapi",
# async tasks
"huey.contrib.djhuey",
# django-overcomingbias-pages
"obpages",
# custom form rendering
"django.forms",
]
# Use the (custom) obpages user model
AUTH_USER_MODEL = "obpages.User"
Search is provided using ``meilisearch``.
To configure search, first set up a MeiliSearch instance, and then set up the following
settings:
.. code-block:: python
# settings.py
MEILISEARCH_CLIENT = {
"url": "http://127.0.0.1:7700",
}
MEILISEARCH_INDEX = "content"
``MEILISEARCH_CLIENT`` specifies the location of the MeiliSearch instance, while
``MEILISEARCH_INDEX`` controls which MeiliSearch index is used for search.
Indexes can be created, updated and deleted via the admin site.
``django-overcomingbias-pages`` uses `Huey <https://github.com/coleifer/huey>`_ to
run tasks asynchronously.
To enable this feature, follow the
`Django/Huey instructions <https://huey.readthedocs.io/en/latest/django.html>`_.
A minimal configuration is shown below:
.. code-block:: python
# settings.py
connection_pool = ConnectionPool(host="127.0.0.1", port=6379, db=0, max_connections=100)
# See docs for full list of settings
HUEY = {
"huey_class": "huey.PriorityRedisHuey",
"name": PROJECT_NAME,
"connection": {
"connection_pool": connection_pool,
# see redis-py for more options
# https://redis-py.readthedocs.io/en/latest/connections.html
"read_timeout": 0,
},
"consumer": {
"workers": 4,
"worker_type": "thread",
},
}
(Note that this requires (1) a Redis server running on localhost:6379 and (2) installing
via ``pip install django-overcomingbias-pages[redis]``.)
Optionally, you can also configure Huey as your
`email backend <https://github.com/chris-mcdo/django-huey-email-backend>`_.
Bugs/Requests
-------------
Please use the
`GitHub issue tracker <https://github.com/chris-mcdo/django-overcomingbias-pages/issues>`_
to submit bugs or request features.
License
-------
Copyright (c) 2022 Christopher McDonald
Distributed under the terms of the
`MIT <https://github.com/chris-mcdo/django-overcomingbias-pages/blob/main/LICENSE>`_
license.
All overcomingbias posts are copyright the original authors.
Raw data
{
"_id": null,
"home_page": "",
"name": "django-overcomingbias-pages",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "content,django,overcomingbias,scrape,website",
"author": "",
"author_email": "Christopher McDonald <cmcdonal33@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8b/7d/cc0365b3d660422a2dbe2215f25679a735b06347db81230fc5a0b0178cc4/django_overcomingbias_pages-0.7.4.tar.gz",
"platform": null,
"description": "django-overcomingbias-pages: a web interface to Robin Hanson's content\n======================================================================\n\n``django-overcomingbias-pages`` is a standalone `Django <https://www.djangoproject.com/>`_\napp which provides a web interface to Robin Hanson's content.\n\nFeatures\n--------\n\nThe main features are:\n\n- Scrape content from across the web (`overcomingbias <https://overcomingbias.com/>`_,\n `YouTube <https://www.youtube.com/>`_, `Spotify <https://spotify.com/>`_\n and more) via the admin site.\n\n- Search content with `meilisearch <https://www.meilisearch.com/>`_.\n\n- Create sequences (series) of content and export them to PDF, epub, plaintext,\n or any other format supported by `pandoc <https://pandoc.org/>`_.\n\n- Persistent user accounts.\n\nConfiguration\n-------------\n\nTo configure ``django-overcomingbias-pages``, add the following to your settings:\n\n.. code-block:: python\n\n # settings.py\n\n # add required apps\n INSTALLED_APPS = [\n # required for admin site / user accounts\n \"django.contrib.admin\",\n \"django.contrib.auth\",\n \"django.contrib.contenttypes\",\n \"django.contrib.sessions\",\n \"django.contrib.messages\",\n # for collecting static files\n \"django.contrib.staticfiles\",\n # django-overcomingbias-api\n \"ordered_model\",\n \"obapi\",\n # async tasks\n \"huey.contrib.djhuey\",\n # django-overcomingbias-pages\n \"obpages\",\n # custom form rendering\n \"django.forms\",\n ]\n\n # Use the (custom) obpages user model \n AUTH_USER_MODEL = \"obpages.User\"\n\n\nSearch is provided using ``meilisearch``.\nTo configure search, first set up a MeiliSearch instance, and then set up the following\nsettings:\n\n.. code-block:: python\n\n # settings.py\n\n MEILISEARCH_CLIENT = {\n \"url\": \"http://127.0.0.1:7700\",\n }\n MEILISEARCH_INDEX = \"content\"\n\n``MEILISEARCH_CLIENT`` specifies the location of the MeiliSearch instance, while\n``MEILISEARCH_INDEX`` controls which MeiliSearch index is used for search.\nIndexes can be created, updated and deleted via the admin site.\n\n``django-overcomingbias-pages`` uses `Huey <https://github.com/coleifer/huey>`_ to\nrun tasks asynchronously.\nTo enable this feature, follow the\n`Django/Huey instructions <https://huey.readthedocs.io/en/latest/django.html>`_.\nA minimal configuration is shown below:\n\n.. code-block:: python\n\n # settings.py\n\n connection_pool = ConnectionPool(host=\"127.0.0.1\", port=6379, db=0, max_connections=100)\n\n # See docs for full list of settings\n HUEY = {\n \"huey_class\": \"huey.PriorityRedisHuey\",\n \"name\": PROJECT_NAME,\n \"connection\": {\n \"connection_pool\": connection_pool,\n # see redis-py for more options\n # https://redis-py.readthedocs.io/en/latest/connections.html\n \"read_timeout\": 0,\n },\n \"consumer\": {\n \"workers\": 4,\n \"worker_type\": \"thread\",\n },\n }\n\n(Note that this requires (1) a Redis server running on localhost:6379 and (2) installing\nvia ``pip install django-overcomingbias-pages[redis]``.)\n\nOptionally, you can also configure Huey as your\n`email backend <https://github.com/chris-mcdo/django-huey-email-backend>`_.\n\nBugs/Requests\n-------------\n\nPlease use the\n`GitHub issue tracker <https://github.com/chris-mcdo/django-overcomingbias-pages/issues>`_\nto submit bugs or request features.\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-pages/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 app web interface to Robin Hanson's content",
"version": "0.7.4",
"split_keywords": [
"content",
"django",
"overcomingbias",
"scrape",
"website"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8d11cdad98ce0880cbfb31819efee96c6a7d7748170702fab54fe8645470c367",
"md5": "9dbcb582cc243dab5a9f07c3c668f881",
"sha256": "901b41ac3d2c356cee741f9538a16d88b73701c33d78f4a7030599acf46fdb1e"
},
"downloads": -1,
"filename": "django_overcomingbias_pages-0.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9dbcb582cc243dab5a9f07c3c668f881",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 101627,
"upload_time": "2023-02-06T17:28:11",
"upload_time_iso_8601": "2023-02-06T17:28:11.448811Z",
"url": "https://files.pythonhosted.org/packages/8d/11/cdad98ce0880cbfb31819efee96c6a7d7748170702fab54fe8645470c367/django_overcomingbias_pages-0.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b7dcc0365b3d660422a2dbe2215f25679a735b06347db81230fc5a0b0178cc4",
"md5": "5b035db92c2de9f8f0025bd3c3abab23",
"sha256": "22b81c3247fc39ad49e1a94181f9e5f7d4ce427535aaa2ebbf283f6eba9460cc"
},
"downloads": -1,
"filename": "django_overcomingbias_pages-0.7.4.tar.gz",
"has_sig": false,
"md5_digest": "5b035db92c2de9f8f0025bd3c3abab23",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 71339,
"upload_time": "2023-02-06T17:28:13",
"upload_time_iso_8601": "2023-02-06T17:28:13.217794Z",
"url": "https://files.pythonhosted.org/packages/8b/7d/cc0365b3d660422a2dbe2215f25679a735b06347db81230fc5a0b0178cc4/django_overcomingbias_pages-0.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-06 17:28:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "django-overcomingbias-pages"
}
