| Name | samaware JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | pretalx plugin with enhanced features for speaker care during a conference |
| upload_time | 2025-08-04 23:06:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
pretalx
conference
event
plugin
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
SamAware
========
SamAware is a [pretalx](https://pretalx.com/) plugin with enhanced features for speaker care during a conference.
It is designed for conference staff taking care of speaker check-in, talk assistance, program coordination, stage operations, and similar tasks.
SamAware was originally developed for the Speakers' Desk at [Chaos Communication Congress](https://en.wikipedia.org/wiki/Chaos_Communication_Congress).
<img src="src/samaware/static/samaware/samovar.svg" alt="Stylized black and white icon of a Samovar tea pot" width="200" />
## Features
SamAware enhances the pretalx orga interface with these features:
- Dashboard with at-a-glance stats on missing speakers, unreleased schedule changes, etc.
- Incremental search for talks by title or speaker name
- Overview page for each talk gathering the relevant submission and speaker information
- List of talks with "Don't record" setting
- Tech Riders for talks with special technical requirements
- Optional sync of the Tech Riders to a [Wekan](https://wekan.fi/) board *(error-prone, to be replaced with sync to another ticket system)*
- Speaker Care Messages with internal information on a speaker that will be displayed prominently when accessing them or their talks
## Installation
> [!WARNING]
> Due to [backward-incompatible changes in django-csp 4](https://django-csp.readthedocs.io/en/latest/migration-guide.html), SamAware is currently not compatible with any released pretalx version, but only the current development version from Git.
> This is going to change with the next pretalx release.
SamAware is available from PyPI and gets installed like any other pretalx plugin.
First, install the package into your pretalx installation's Python environment:
(env) > pip install samaware
Next, you need to collect and compress static assets:
(env) > DJANGO_SETTINGS_MODULE=pretalx.settings django-admin collectstatic
(env) > DJANGO_SETTINGS_MODULE=pretalx.settings django-admin compress
Afterward, restart pretalx.
SamAware should now appear in the pretalx orga interface of your Event under "Settings" / "Plugins" / "Features".
You can enable it there for each Event.
SamAware requires no configuration unless you plan to use Wekan sync of Tech Riders.
For that feature, provide the required information under "Settings" / "SamAware".
## Development
For a local development environment, set up a [Python venv](https://docs.python.org/3/library/venv.html) or use a dev container.
pretalx itself must be installed in that environment.
One option is to create a full development setup as described [in the pretalx docs](https://docs.pretalx.org/developer/setup/).
Alternatively, you can get the latest pretalx release from PyPI by running:
> pip install pretalx
In both cases, you then clone the SamAware repo, change to that source directory, and add it to your environment like this:
> pip install -e .[dev]
You probably need to collect and compress static assets and apply migrations:
> DJANGO_SETTINGS_MODULE=pretalx.settings django-admin collectstatic
> DJANGO_SETTINGS_MODULE=pretalx.settings django-admin compress
> DJANGO_SETTINGS_MODULE=pretalx.settings django-admin migrate
If not done already, initialize your pretalx dev instance through:
> DJANGO_SETTINGS_MODULE=pretalx.settings django-admin init
It is useful to create a demo Event for development.
This requires the "Faker" and "freezegun" Python packages.
Setting it up in the "schedule" stage provides the best starting point for SamAware development:
> pip install Faker freezegun
> DJANGO_SETTINGS_MODULE=pretalx.settings django-admin create_test_event --stage schedule
Now, you should be able to start the development server through:
make run
Make sure to have a look at the Makefile as it also provides useful targets for testing and linting.
Finally, open the running instance in a browser and enable SamAware in the orga interface for your demo Event under "Settings" / "Plugins" / "Features".
## Security
Should you encounter any security vulnerabilities in SamAware, please report them privately.
Use GitHub vulnerability reporting or contact Felix Dreissig directly.
## Copyright
SamAware has been created by Felix Dreissig.
It is released under the ISC License.
Raw data
{
"_id": null,
"home_page": null,
"name": "samaware",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "pretalx, conference, event, plugin",
"author": null,
"author_email": "Felix Dreissig <f30@f30.me>",
"download_url": "https://files.pythonhosted.org/packages/ee/93/6a34efab6bce5f40d33079a4dee9d39df13eb5748af8f06ce55c6f2b9330/samaware-1.0.0.tar.gz",
"platform": null,
"description": "SamAware\n========\n\nSamAware is a [pretalx](https://pretalx.com/) plugin with enhanced features for speaker care during a conference.\n\nIt is designed for conference staff taking care of speaker check-in, talk assistance, program coordination, stage operations, and similar tasks.\nSamAware was originally developed for the Speakers' Desk at [Chaos Communication Congress](https://en.wikipedia.org/wiki/Chaos_Communication_Congress).\n\n<img src=\"src/samaware/static/samaware/samovar.svg\" alt=\"Stylized black and white icon of a Samovar tea pot\" width=\"200\" />\n\n## Features\n\nSamAware enhances the pretalx orga interface with these features:\n\n- Dashboard with at-a-glance stats on missing speakers, unreleased schedule changes, etc.\n- Incremental search for talks by title or speaker name\n- Overview page for each talk gathering the relevant submission and speaker information\n- List of talks with \"Don't record\" setting\n- Tech Riders for talks with special technical requirements\n- Optional sync of the Tech Riders to a [Wekan](https://wekan.fi/) board *(error-prone, to be replaced with sync to another ticket system)*\n- Speaker Care Messages with internal information on a speaker that will be displayed prominently when accessing them or their talks\n\n## Installation\n\n> [!WARNING]\n> Due to [backward-incompatible changes in django-csp 4](https://django-csp.readthedocs.io/en/latest/migration-guide.html), SamAware is currently not compatible with any released pretalx version, but only the current development version from Git.\n> This is going to change with the next pretalx release.\n\nSamAware is available from PyPI and gets installed like any other pretalx plugin.\nFirst, install the package into your pretalx installation's Python environment:\n\n (env) > pip install samaware\n\nNext, you need to collect and compress static assets:\n\n (env) > DJANGO_SETTINGS_MODULE=pretalx.settings django-admin collectstatic\n (env) > DJANGO_SETTINGS_MODULE=pretalx.settings django-admin compress\n\nAfterward, restart pretalx.\n\nSamAware should now appear in the pretalx orga interface of your Event under \"Settings\" / \"Plugins\" / \"Features\".\nYou can enable it there for each Event.\n\nSamAware requires no configuration unless you plan to use Wekan sync of Tech Riders.\nFor that feature, provide the required information under \"Settings\" / \"SamAware\".\n\n## Development\n\nFor a local development environment, set up a [Python venv](https://docs.python.org/3/library/venv.html) or use a dev container.\n\npretalx itself must be installed in that environment.\nOne option is to create a full development setup as described [in the pretalx docs](https://docs.pretalx.org/developer/setup/).\nAlternatively, you can get the latest pretalx release from PyPI by running:\n\n > pip install pretalx\n\nIn both cases, you then clone the SamAware repo, change to that source directory, and add it to your environment like this:\n\n > pip install -e .[dev]\n\nYou probably need to collect and compress static assets and apply migrations:\n\n > DJANGO_SETTINGS_MODULE=pretalx.settings django-admin collectstatic\n > DJANGO_SETTINGS_MODULE=pretalx.settings django-admin compress\n > DJANGO_SETTINGS_MODULE=pretalx.settings django-admin migrate\n\nIf not done already, initialize your pretalx dev instance through:\n\n > DJANGO_SETTINGS_MODULE=pretalx.settings django-admin init\n\nIt is useful to create a demo Event for development.\nThis requires the \"Faker\" and \"freezegun\" Python packages.\nSetting it up in the \"schedule\" stage provides the best starting point for SamAware development:\n\n > pip install Faker freezegun\n > DJANGO_SETTINGS_MODULE=pretalx.settings django-admin create_test_event --stage schedule\n\nNow, you should be able to start the development server through:\n\n make run\n\nMake sure to have a look at the Makefile as it also provides useful targets for testing and linting.\n\nFinally, open the running instance in a browser and enable SamAware in the orga interface for your demo Event under \"Settings\" / \"Plugins\" / \"Features\".\n\n## Security\n\nShould you encounter any security vulnerabilities in SamAware, please report them privately.\nUse GitHub vulnerability reporting or contact Felix Dreissig directly.\n\n## Copyright\n\nSamAware has been created by Felix Dreissig.\n\nIt is released under the ISC License.\n",
"bugtrack_url": null,
"license": null,
"summary": "pretalx plugin with enhanced features for speaker care during a conference",
"version": "1.0.0",
"project_urls": {
"Issues": "https://github.com/f30/samaware/issues",
"homepage": "https://github.com/f30/samaware",
"repository": "https://github.com/f30/samaware.git"
},
"split_keywords": [
"pretalx",
" conference",
" event",
" plugin"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5ef05bd785c2c586fdb77d651759d2b2fd5e4b450ba16f815a1857c91b5a1f91",
"md5": "a56c12862ceafda9dcc200c02cb3f930",
"sha256": "8fe02b78a55c887c3fc98b12434400ae18aca85ad4374991705971040561f631"
},
"downloads": -1,
"filename": "samaware-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a56c12862ceafda9dcc200c02cb3f930",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 55095,
"upload_time": "2025-08-04T23:06:23",
"upload_time_iso_8601": "2025-08-04T23:06:23.710499Z",
"url": "https://files.pythonhosted.org/packages/5e/f0/5bd785c2c586fdb77d651759d2b2fd5e4b450ba16f815a1857c91b5a1f91/samaware-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ee936a34efab6bce5f40d33079a4dee9d39df13eb5748af8f06ce55c6f2b9330",
"md5": "68edac0561dbf149162ea7e6807ceec3",
"sha256": "ebca565f4910f876a45f888387e2ed76148dccf2e8fc148c6afa9541a883ce87"
},
"downloads": -1,
"filename": "samaware-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "68edac0561dbf149162ea7e6807ceec3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 51608,
"upload_time": "2025-08-04T23:06:25",
"upload_time_iso_8601": "2025-08-04T23:06:25.102183Z",
"url": "https://files.pythonhosted.org/packages/ee/93/6a34efab6bce5f40d33079a4dee9d39df13eb5748af8f06ce55c6f2b9330/samaware-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-04 23:06:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "f30",
"github_project": "samaware",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "samaware"
}
