| Name | pretalx-youtube JSON |
| Version |
2.3.0
JSON |
| download |
| home_page | None |
| Summary | Static youtube for pretalx, e.g. information, venue listings, a Code of Conduct, etc. |
| upload_time | 2024-10-21 00:24:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | Apache Software License |
| keywords |
pretalx
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Youtube integration
===================
This is a plugin for `pretalx`_ that provides an integration with Youtube, allowing you to embed recordings on talk pages.
.. image:: https://github.com/pretalx/pretalx-youtube/blob/main/assets/screenshot.png?raw=true
API
---
Reading data
~~~~~~~~~~~~
The Plugin supplies an API at ``/api/events/<event>/p/youtube/`` that returns all configured Youtube URLs:
.. code:: json
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"submission": "DPC6RT",
"youtube_link": "https://youtube.com/watch?v=AAAAAB",
"video_id": "AAAAAB"
},
]
}
A detail view for specific submissions is available at ``/api/events/<event>/p/youtube/<code>/``:
.. code:: json
{
"submission": "DPC6RT",
"youtube_link": "https://youtube.com/watch?v=AAAAAB",
"video_id": "AAAAAB"
}
Writing data
~~~~~~~~~~~~
You can use ``POST`` requests against the list endpoint and ``PATCH`` or ``PUT`` requests against the detail endpoint to
create or update Youtube links. The ``video_id`` field is required, as is the ``submission`` field unless you are using
``PATCH``. The ``submission`` field must be the code of an existing submission, and the API will take care of updating
existing links if you use ``POST``, so it's safe to just always ``POST`` to the list endpoint.
You can also **bulk import** data in either JSON or CSV format. The JSON format is the same as the one used by the API,
and the CSV format is a simple CSV file with a header row containing the fields ``submission`` and ``video_id``. You can
upload the file to ``/api/events/<event>/p/youtube/import/`` using a ``POST`` request with the file as the body.
(For JSON, you can also instead put the data in the request body.)
Development setup
-----------------
1. Make sure that you have a working `pretalx development setup`_.
2. Clone this repository, eg to ``local/pretalx-youtube``.
3. Activate the virtual environment you use for pretalx development.
4. Execute ``python setup.py develop`` within this directory to register this application with pretalx's plugin registry.
5. Execute ``make`` within this directory to compile translations.
6. Restart your local pretalx server. You can now use the plugin from this repository for your events by enabling it in
the 'plugins' tab in the settings.
License
-------
Copyright 2021 Tobias Kunze
Released under the terms of the Apache License 2.0
.. _pretalx: https://github.com/pretalx/pretalx
.. _pretalx development setup: https://docs.pretalx.org/en/latest/developer/setup.html
Raw data
{
"_id": null,
"home_page": null,
"name": "pretalx-youtube",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "Tobias Kunze <r@rixx.de>",
"keywords": "pretalx",
"author": null,
"author_email": "Tobias Kunze <r@rixx.de>",
"download_url": "https://files.pythonhosted.org/packages/dc/16/822bdc029e3902752ca835b770d3d165eea9f7b8334f79a8d4eb182691a2/pretalx_youtube-2.3.0.tar.gz",
"platform": null,
"description": "Youtube integration\n===================\n\nThis is a plugin for `pretalx`_ that provides an integration with Youtube, allowing you to embed recordings on talk pages.\n\n.. image:: https://github.com/pretalx/pretalx-youtube/blob/main/assets/screenshot.png?raw=true\n\nAPI\n---\n\nReading data\n~~~~~~~~~~~~\n\nThe Plugin supplies an API at ``/api/events/<event>/p/youtube/`` that returns all configured Youtube URLs:\n\n.. code:: json\n\n {\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"submission\": \"DPC6RT\",\n \"youtube_link\": \"https://youtube.com/watch?v=AAAAAB\",\n \"video_id\": \"AAAAAB\"\n },\n ]\n }\n\nA detail view for specific submissions is available at ``/api/events/<event>/p/youtube/<code>/``:\n\n.. code:: json\n\n {\n \"submission\": \"DPC6RT\",\n \"youtube_link\": \"https://youtube.com/watch?v=AAAAAB\",\n \"video_id\": \"AAAAAB\"\n }\n\nWriting data\n~~~~~~~~~~~~\n\nYou can use ``POST`` requests against the list endpoint and ``PATCH`` or ``PUT`` requests against the detail endpoint to\ncreate or update Youtube links. The ``video_id`` field is required, as is the ``submission`` field unless you are using\n``PATCH``. The ``submission`` field must be the code of an existing submission, and the API will take care of updating\nexisting links if you use ``POST``, so it's safe to just always ``POST`` to the list endpoint.\n\nYou can also **bulk import** data in either JSON or CSV format. The JSON format is the same as the one used by the API,\nand the CSV format is a simple CSV file with a header row containing the fields ``submission`` and ``video_id``. You can\nupload the file to ``/api/events/<event>/p/youtube/import/`` using a ``POST`` request with the file as the body.\n(For JSON, you can also instead put the data in the request body.)\n\n\nDevelopment setup\n-----------------\n\n1. Make sure that you have a working `pretalx development setup`_.\n\n2. Clone this repository, eg to ``local/pretalx-youtube``.\n\n3. Activate the virtual environment you use for pretalx development.\n\n4. Execute ``python setup.py develop`` within this directory to register this application with pretalx's plugin registry.\n\n5. Execute ``make`` within this directory to compile translations.\n\n6. Restart your local pretalx server. You can now use the plugin from this repository for your events by enabling it in\n the 'plugins' tab in the settings.\n\n\nLicense\n-------\n\nCopyright 2021 Tobias Kunze\n\nReleased under the terms of the Apache License 2.0\n\n\n.. _pretalx: https://github.com/pretalx/pretalx\n.. _pretalx development setup: https://docs.pretalx.org/en/latest/developer/setup.html\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Static youtube for pretalx, e.g. information, venue listings, a Code of Conduct, etc.",
"version": "2.3.0",
"project_urls": {
"homepage": "https://github.com/pretalx/pretalx-youtube",
"repository": "https://github.com/pretalx/pretalx-youtube.git"
},
"split_keywords": [
"pretalx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8c41dd9aac41336e760c7c8ae922ab814dedb58ffee84999e7e5c77f6142effb",
"md5": "34285355033e80ff0cd888635916b72e",
"sha256": "5f65f03a3875ec461f0249fc02df744f8f0407ae2858b565cb24f7265acc0bda"
},
"downloads": -1,
"filename": "pretalx_youtube-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "34285355033e80ff0cd888635916b72e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 58811,
"upload_time": "2024-10-21T00:24:36",
"upload_time_iso_8601": "2024-10-21T00:24:36.092041Z",
"url": "https://files.pythonhosted.org/packages/8c/41/dd9aac41336e760c7c8ae922ab814dedb58ffee84999e7e5c77f6142effb/pretalx_youtube-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc16822bdc029e3902752ca835b770d3d165eea9f7b8334f79a8d4eb182691a2",
"md5": "945e5028cef1138e9affb47e40b7260e",
"sha256": "78487c144fcbc1fd7fe6a5cce5afeb18f987a6752602e7c108bc9e783a7a6cc4"
},
"downloads": -1,
"filename": "pretalx_youtube-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "945e5028cef1138e9affb47e40b7260e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17104,
"upload_time": "2024-10-21T00:24:37",
"upload_time_iso_8601": "2024-10-21T00:24:37.808988Z",
"url": "https://files.pythonhosted.org/packages/dc/16/822bdc029e3902752ca835b770d3d165eea9f7b8334f79a8d4eb182691a2/pretalx_youtube-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 00:24:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pretalx",
"github_project": "pretalx-youtube",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pretalx-youtube"
}
