lauschkiste-core 0.1.0a4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lauschkiste_core-0.1.0a4/.gitignore +48 -0
- lauschkiste_core-0.1.0a4/LICENSE +22 -0
- lauschkiste_core-0.1.0a4/PKG-INFO +49 -0
- lauschkiste_core-0.1.0a4/README.md +11 -0
- lauschkiste_core-0.1.0a4/interfaces/_contract.json +62 -0
- lauschkiste_core-0.1.0a4/interfaces/audiobooks.json +204 -0
- lauschkiste_core-0.1.0a4/interfaces/cache.json +305 -0
- lauschkiste_core-0.1.0a4/interfaces/cards.json +195 -0
- lauschkiste_core-0.1.0a4/interfaces/hardware.json +310 -0
- lauschkiste_core-0.1.0a4/interfaces/input.json +97 -0
- lauschkiste_core-0.1.0a4/interfaces/jingle.json +30 -0
- lauschkiste_core-0.1.0a4/interfaces/library.json +927 -0
- lauschkiste_core-0.1.0a4/interfaces/player.json +1308 -0
- lauschkiste_core-0.1.0a4/interfaces/podcasts.json +788 -0
- lauschkiste_core-0.1.0a4/interfaces/radio.json +686 -0
- lauschkiste_core-0.1.0a4/interfaces/rfid.json +84 -0
- lauschkiste_core-0.1.0a4/interfaces/system.json +282 -0
- lauschkiste_core-0.1.0a4/interfaces/time_limits.json +262 -0
- lauschkiste_core-0.1.0a4/interfaces/timers.json +277 -0
- lauschkiste_core-0.1.0a4/interfaces/volume.json +455 -0
- lauschkiste_core-0.1.0a4/pyproject.toml +72 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/__init__.py +4 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/api/__init__.py +5 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/api/events.py +86 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/api/fastapi_server.py +284 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/api/webapp_static.py +88 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/audio_output.py +196 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/audiobooks.py +219 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/cache/__init__.py +245 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/cache/manager.py +118 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/cache/store.py +74 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/cache/worker.py +167 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/cfghandler.py +385 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/__init__.py +13 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/catalog.py +101 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/context.py +178 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/declarations.py +232 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/errors.py +16 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/interfaces.py +291 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/manager.py +284 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/module.py +158 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/plugins.py +317 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/routes.py +268 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/secrets.py +71 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/settings.py +143 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/snapshots.py +102 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/contract/version.py +3 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/core_modules.py +35 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/daemon.py +192 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/directories.py +55 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/dismissed.py +34 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/hardware.py +218 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/input_devices.py +287 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/jingle.py +87 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/library/__init__.py +15 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/library/covers.py +121 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/library/files.py +374 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/library/index.py +236 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/library/module.py +392 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/library/watch.py +196 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/misc/__init__.py +37 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/misc/inputminus.py +90 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/misc/loggingext.py +178 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/misc/simplecolors.py +54 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/multitimer.py +377 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/nv_manager.py +119 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/paths.py +79 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/player/__init__.py +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/player/backend.py +73 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/player/backends/__init__.py +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/player/backends/local_audio.py +572 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/player/coordinator.py +263 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/player/module.py +395 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/player/status.py +95 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/playlistgenerator.py +290 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/podcast_opml.py +44 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/podcasts.py +631 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/publishing/__init__.py +10 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/publishing/bus.py +70 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/radio.py +346 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/radio_playlist.py +51 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/audio/shutdownsound.wav +0 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/audio/startupsound.wav +0 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/autohotspot/NetworkManager/autohotspot +353 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/autohotspot/NetworkManager/autohotspot.service +11 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/autohotspot/NetworkManager/autohotspot.timer +10 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/autohotspot/dhcpcd/autohotspot +228 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/autohotspot/dhcpcd/autohotspot-daemon.service +10 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/autohotspot/dhcpcd/autohotspot.service +11 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/autohotspot/dhcpcd/autohotspot.timer +10 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/autohotspot/dhcpcd/dnsmasq.conf +7 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/autohotspot/dhcpcd/hostapd +20 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/autohotspot/dhcpcd/hostapd.conf +20 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/default-settings/cards.example.yaml +23 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/default-settings/gpio.example.yaml +75 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/default-settings/lauschkiste.default.yaml +127 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/default-settings/logger.default.yaml +72 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/default-settings/mpd.default.conf +421 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resources/system/99-lauschkiste-welcome +17 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/resume.py +236 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/rfid/__init__.py +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/rfid/cards/__init__.py +157 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/rfid/cardutils.py +28 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/rfid/reader/__init__.py +255 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/rfid/readerbase.py +45 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/startup.py +22 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/statefile.py +67 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/system.py +236 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/time_limits/__init__.py +304 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/time_limits/rules.py +38 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/timers.py +162 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/utils.py +39 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/version.py +31 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/volume.py +364 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/ArrowBack-BKRtCkSW.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Cards-K7spOfM9.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Delete-Cd5Kg0Kj.js +52 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Header-CNUfzutC.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Help-YtQQWSe4.js +3 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/KeyboardArrowRight-BXVjbres.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Library-Bp0-lXOh.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Link-DNJrJemu.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/ListItemAvatar-BJrZQQBm.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/ListItemIcon-JElzN3Sx.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/NativeSelectInput-CaCcJ619.js +3 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Player-CPywhcqH.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/QueueMusic-zPVz6Y5Y.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/RadioGroup-71oK2M4g.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Search-ChfzApGV.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Settings-lTlPwq2H.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Stack-B8NWi7tf.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/Terminal-r0AC5fJU.js +2 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/TextField-bz1cRs6v.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/VolumeUp-CcCWFwRa.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/createSvgIcon-DEp1jqY5.js +135 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/general-Codyq2By.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/index-CZknmtgF.js +37 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/listItemIconClasses-B5QVJTH8.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/rolldown-runtime-CbXtAM7H.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/assets/song-list-item-CJ6a8liP.js +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/favicon.ico +0 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/de/cards.md +30 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/de/lauschctl.md +70 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/de/library.md +49 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/de/player.md +25 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/de/settings.md +21 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/de/start.md +20 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/de/troubleshooting.md +30 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/en/cards.md +30 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/en/lauschctl.md +70 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/en/library.md +49 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/en/player.md +25 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/en/settings.md +21 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/en/start.md +20 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/help/en/troubleshooting.md +30 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/index.html +20 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/locales/de/translation.json +973 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/locales/en/translation.json +837 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/logo.svg +1 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/logo192.png +0 -0
- lauschkiste_core-0.1.0a4/src/lauschkiste/webapp/manifest.json +20 -0
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Shared folder
|
|
2
|
+
/shared/library/*
|
|
3
|
+
/shared/logs/*
|
|
4
|
+
/shared/playlists/*
|
|
5
|
+
/shared/settings/*
|
|
6
|
+
/shared/logs/*.log*
|
|
7
|
+
/shared/*.*
|
|
8
|
+
/shared/*
|
|
9
|
+
/packages/webapp/public/cover-cache/*.*
|
|
10
|
+
/packages/webapp/test-results/
|
|
11
|
+
/packages/lauschkiste/src/lauschkiste/webapp/
|
|
12
|
+
/dist/
|
|
13
|
+
/packages/webapp/playwright-report/
|
|
14
|
+
|
|
15
|
+
# Byte-compiled / optimized / DLL files
|
|
16
|
+
__pycache__/
|
|
17
|
+
*.py[cod]
|
|
18
|
+
|
|
19
|
+
.git
|
|
20
|
+
.venv
|
|
21
|
+
*~
|
|
22
|
+
*.*~
|
|
23
|
+
*.pyc
|
|
24
|
+
*.idea
|
|
25
|
+
*.vscode
|
|
26
|
+
.DS_Store
|
|
27
|
+
**/.mypy_cache
|
|
28
|
+
|
|
29
|
+
# Keep folders with .gitkeep
|
|
30
|
+
!/**/.gitkeep
|
|
31
|
+
|
|
32
|
+
# Development Scratchpads
|
|
33
|
+
/**/scratch
|
|
34
|
+
/**/scratch_*
|
|
35
|
+
|
|
36
|
+
# Local debug/build artifacts
|
|
37
|
+
/app.log
|
|
38
|
+
/*.tar.gz
|
|
39
|
+
|
|
40
|
+
# bam local cache and test reports
|
|
41
|
+
/.bam/
|
|
42
|
+
/.reports/
|
|
43
|
+
/.coverage
|
|
44
|
+
/coverage.xml
|
|
45
|
+
|
|
46
|
+
# Local secrets for tests and scripts (never committed)
|
|
47
|
+
.env
|
|
48
|
+
.env.local
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2017 Micz Flor
|
|
4
|
+
Copyright (c) 2026 the Lauschkiste contributors
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
in the Software without restriction, including without limitation the rights
|
|
9
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
SOFTWARE.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: lauschkiste-core
|
|
3
|
+
Version: 0.1.0a4
|
|
4
|
+
Summary: Lauschkiste core: player, library, cards, volume, timers and the web API of the RFID audio player
|
|
5
|
+
Project-URL: Homepage, https://github.com/ladidadida/lauschkiste
|
|
6
|
+
Project-URL: Documentation, https://github.com/ladidadida/lauschkiste/tree/main/documentation
|
|
7
|
+
Project-URL: Issues, https://github.com/ladidadida/lauschkiste/issues
|
|
8
|
+
Project-URL: Changelog, https://github.com/ladidadida/lauschkiste/releases
|
|
9
|
+
Author: the Lauschkiste contributors
|
|
10
|
+
License-Expression: MIT
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Keywords: audiobooks,home automation,kids,music player,raspberry pi,rfid
|
|
13
|
+
Classifier: Development Status :: 3 - Alpha
|
|
14
|
+
Classifier: Intended Audience :: End Users/Desktop
|
|
15
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
21
|
+
Classifier: Topic :: Home Automation
|
|
22
|
+
Classifier: Topic :: Multimedia :: Sound/Audio :: Players
|
|
23
|
+
Requires-Python: >=3.11
|
|
24
|
+
Requires-Dist: audioop-lts; python_version >= '3.13'
|
|
25
|
+
Requires-Dist: av
|
|
26
|
+
Requires-Dist: av<13.1; python_version < '3.12' and (platform_machine == 'armv6l' or platform_machine == 'armv7l')
|
|
27
|
+
Requires-Dist: evdev
|
|
28
|
+
Requires-Dist: fastapi
|
|
29
|
+
Requires-Dist: mutagen
|
|
30
|
+
Requires-Dist: packaging
|
|
31
|
+
Requires-Dist: pulsectl
|
|
32
|
+
Requires-Dist: pydantic>=2
|
|
33
|
+
Requires-Dist: requests
|
|
34
|
+
Requires-Dist: ruamel-yaml
|
|
35
|
+
Requires-Dist: sounddevice
|
|
36
|
+
Requires-Dist: uvicorn
|
|
37
|
+
Description-Content-Type: text/markdown
|
|
38
|
+
|
|
39
|
+
# Lauschkiste core
|
|
40
|
+
|
|
41
|
+
The core of [Lauschkiste](https://github.com/ladidadida/lauschkiste), an open-source RFID audio player for kids: player, library,
|
|
42
|
+
cards, volume, timers, the web API and the web app, and the contract plugins are built on.
|
|
43
|
+
|
|
44
|
+
This package is a dependency, not something to install on its own. Install
|
|
45
|
+
[`lauschkiste`](https://pypi.org/project/lauschkiste/), which brings the `lauschkiste` and
|
|
46
|
+
`lauschctl` commands. The Python module is `lauschkiste`; versions of all Lauschkiste packages
|
|
47
|
+
match exactly.
|
|
48
|
+
|
|
49
|
+
Documentation: [for developers](https://github.com/ladidadida/lauschkiste/blob/main/documentation/developers/README.md). MIT license.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Lauschkiste core
|
|
2
|
+
|
|
3
|
+
The core of [Lauschkiste](https://github.com/ladidadida/lauschkiste), an open-source RFID audio player for kids: player, library,
|
|
4
|
+
cards, volume, timers, the web API and the web app, and the contract plugins are built on.
|
|
5
|
+
|
|
6
|
+
This package is a dependency, not something to install on its own. Install
|
|
7
|
+
[`lauschkiste`](https://pypi.org/project/lauschkiste/), which brings the `lauschkiste` and
|
|
8
|
+
`lauschctl` commands. The Python module is `lauschkiste`; versions of all Lauschkiste packages
|
|
9
|
+
match exactly.
|
|
10
|
+
|
|
11
|
+
Documentation: [for developers](https://github.com/ladidadida/lauschkiste/blob/main/documentation/developers/README.md). MIT license.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
{
|
|
2
|
+
"Context": {
|
|
3
|
+
"__init__": "(self, handle: 'ModuleHandle', *, bus, config: lauschkiste.contract.context.ModuleConfig, modules: lauschkiste.contract.context.ModulesView, actions: 'ActionCatalog', strict: bool)",
|
|
4
|
+
"close": "(self) -> None",
|
|
5
|
+
"executor": "(self, name: str, workers: int = 1) -> concurrent.futures.thread.ThreadPoolExecutor",
|
|
6
|
+
"lock": "property",
|
|
7
|
+
"name": "property",
|
|
8
|
+
"publish": "(self, spec: lauschkiste.contract.declarations.EventSpec, payload) -> None",
|
|
9
|
+
"revoke": "(self, spec: lauschkiste.contract.declarations.EventSpec) -> None",
|
|
10
|
+
"subscribe": "(self, topic_prefix: str, callback: Callable[[str, Any | None], NoneType]) -> None",
|
|
11
|
+
"topic": "(self, spec: lauschkiste.contract.declarations.EventSpec) -> str"
|
|
12
|
+
},
|
|
13
|
+
"ExtensionPoint": {
|
|
14
|
+
"__init__": "(self, name: str, protocol: type)",
|
|
15
|
+
"get": "(self, key: str) -> Any",
|
|
16
|
+
"items": "(self)",
|
|
17
|
+
"names": "(self)",
|
|
18
|
+
"on_register": "(self, listener: Callable[[str, Any], NoneType]) -> None",
|
|
19
|
+
"register": "(self, key: str, implementation: Any) -> None",
|
|
20
|
+
"unregister": "(self, key: str) -> None"
|
|
21
|
+
},
|
|
22
|
+
"Module": {
|
|
23
|
+
"concurrency": "attribute",
|
|
24
|
+
"events": "(cls) -> Dict[str, lauschkiste.contract.declarations.EventSpec]",
|
|
25
|
+
"extension_point_specs": "(cls) -> Dict[str, lauschkiste.contract.declarations.ExtensionPointSpec]",
|
|
26
|
+
"extra_routes": "(self, router) -> None",
|
|
27
|
+
"interface_version": "attribute",
|
|
28
|
+
"is_core": "attribute",
|
|
29
|
+
"operations": "(cls) -> Dict[str, lauschkiste.contract.declarations.Operation]",
|
|
30
|
+
"ready": "(self) -> None",
|
|
31
|
+
"required_modules": "(cls) -> Dict[str, str | None]",
|
|
32
|
+
"requires": "attribute",
|
|
33
|
+
"settings": "attribute",
|
|
34
|
+
"settings_changed": "(self, changed: Dict[str, Any]) -> bool",
|
|
35
|
+
"start": "(self, ctx: 'Context') -> None",
|
|
36
|
+
"stop": "(self) -> List[threading.Thread]",
|
|
37
|
+
"validate_declaration": "(cls) -> None"
|
|
38
|
+
},
|
|
39
|
+
"ModuleConfig": {
|
|
40
|
+
"__init__": "(self, cfg, prefix: Tuple[str, ...])",
|
|
41
|
+
"as_dict": "(self) -> Dict[str, Any]",
|
|
42
|
+
"get": "(self, *keys, default=None)",
|
|
43
|
+
"set": "(self, *keys, value) -> None",
|
|
44
|
+
"setdefault": "(self, *keys, value)"
|
|
45
|
+
},
|
|
46
|
+
"Plugin": {
|
|
47
|
+
"contract": "attribute",
|
|
48
|
+
"detect": "(cls, read: Callable[[str], str | None]) -> str | None",
|
|
49
|
+
"extras": "attribute",
|
|
50
|
+
"needs": "attribute",
|
|
51
|
+
"provides": "attribute",
|
|
52
|
+
"title": "attribute",
|
|
53
|
+
"validate_declaration": "(cls) -> None"
|
|
54
|
+
},
|
|
55
|
+
"contract_version": "2.3",
|
|
56
|
+
"functions": {
|
|
57
|
+
"action": "(func: Callable | None = None, *, method: str = 'POST', path: str | None = None, exclusive: bool = True, name: str | None = None, status_code: int | None = None)",
|
|
58
|
+
"event": "(name: str, model: Type[pydantic.main.BaseModel]) -> lauschkiste.contract.declarations.EventSpec",
|
|
59
|
+
"extension_point": "(name: str, protocol: type) -> lauschkiste.contract.declarations.ExtensionPointSpec",
|
|
60
|
+
"query": "(func: Callable | None = None, *, path: str | None = None, exclusive: bool = True, name: str | None = None)"
|
|
61
|
+
}
|
|
62
|
+
}
|
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
{
|
|
2
|
+
"events": {},
|
|
3
|
+
"extension_points": {
|
|
4
|
+
"sources": {
|
|
5
|
+
"files": "(self, book: str) -> List[str]",
|
|
6
|
+
"list_books": "(self) -> List[Dict[str, Any]]",
|
|
7
|
+
"position": "(self, book: str) -> Any",
|
|
8
|
+
"set_finished": "(self, book: str, finished: bool) -> None",
|
|
9
|
+
"title": "(self, book: str) -> str"
|
|
10
|
+
}
|
|
11
|
+
},
|
|
12
|
+
"interface_version": "4.0",
|
|
13
|
+
"kind": "core",
|
|
14
|
+
"name": "audiobooks",
|
|
15
|
+
"operations": {
|
|
16
|
+
"hide_from_continue": {
|
|
17
|
+
"args": {
|
|
18
|
+
"additionalProperties": false,
|
|
19
|
+
"properties": {
|
|
20
|
+
"book": {
|
|
21
|
+
"type": "string"
|
|
22
|
+
},
|
|
23
|
+
"source": {
|
|
24
|
+
"default": "local",
|
|
25
|
+
"type": "string"
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
"required": [
|
|
29
|
+
"book"
|
|
30
|
+
],
|
|
31
|
+
"type": "object"
|
|
32
|
+
},
|
|
33
|
+
"kind": "action",
|
|
34
|
+
"method": "POST",
|
|
35
|
+
"path": "/api/v1/audiobooks/hide_from_continue",
|
|
36
|
+
"returns": {
|
|
37
|
+
"type": "null"
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"list_books": {
|
|
41
|
+
"args": {
|
|
42
|
+
"additionalProperties": false,
|
|
43
|
+
"properties": {},
|
|
44
|
+
"type": "object"
|
|
45
|
+
},
|
|
46
|
+
"kind": "query",
|
|
47
|
+
"method": "GET",
|
|
48
|
+
"path": "/api/v1/audiobooks",
|
|
49
|
+
"returns": {
|
|
50
|
+
"items": {
|
|
51
|
+
"properties": {
|
|
52
|
+
"availability": {
|
|
53
|
+
"default": "local",
|
|
54
|
+
"type": "string"
|
|
55
|
+
},
|
|
56
|
+
"book": {
|
|
57
|
+
"type": "string"
|
|
58
|
+
},
|
|
59
|
+
"chapter": {
|
|
60
|
+
"default": 0,
|
|
61
|
+
"type": "integer"
|
|
62
|
+
},
|
|
63
|
+
"chapters": {
|
|
64
|
+
"type": "integer"
|
|
65
|
+
},
|
|
66
|
+
"cover_url": {
|
|
67
|
+
"anyOf": [
|
|
68
|
+
{
|
|
69
|
+
"type": "string"
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"type": "null"
|
|
73
|
+
}
|
|
74
|
+
],
|
|
75
|
+
"default": null
|
|
76
|
+
},
|
|
77
|
+
"duration": {
|
|
78
|
+
"anyOf": [
|
|
79
|
+
{
|
|
80
|
+
"type": "number"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"type": "null"
|
|
84
|
+
}
|
|
85
|
+
],
|
|
86
|
+
"default": null
|
|
87
|
+
},
|
|
88
|
+
"elapsed": {
|
|
89
|
+
"default": 0.0,
|
|
90
|
+
"type": "number"
|
|
91
|
+
},
|
|
92
|
+
"finished": {
|
|
93
|
+
"default": false,
|
|
94
|
+
"type": "boolean"
|
|
95
|
+
},
|
|
96
|
+
"hidden": {
|
|
97
|
+
"default": false,
|
|
98
|
+
"type": "boolean"
|
|
99
|
+
},
|
|
100
|
+
"listened": {
|
|
101
|
+
"default": 0.0,
|
|
102
|
+
"type": "number"
|
|
103
|
+
},
|
|
104
|
+
"source": {
|
|
105
|
+
"default": "local",
|
|
106
|
+
"type": "string"
|
|
107
|
+
},
|
|
108
|
+
"title": {
|
|
109
|
+
"type": "string"
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
"required": [
|
|
113
|
+
"book",
|
|
114
|
+
"title",
|
|
115
|
+
"chapters"
|
|
116
|
+
],
|
|
117
|
+
"type": "object"
|
|
118
|
+
},
|
|
119
|
+
"type": "array"
|
|
120
|
+
}
|
|
121
|
+
},
|
|
122
|
+
"play": {
|
|
123
|
+
"args": {
|
|
124
|
+
"additionalProperties": false,
|
|
125
|
+
"properties": {
|
|
126
|
+
"book": {
|
|
127
|
+
"type": "string"
|
|
128
|
+
},
|
|
129
|
+
"source": {
|
|
130
|
+
"default": "local",
|
|
131
|
+
"type": "string"
|
|
132
|
+
}
|
|
133
|
+
},
|
|
134
|
+
"required": [
|
|
135
|
+
"book"
|
|
136
|
+
],
|
|
137
|
+
"type": "object"
|
|
138
|
+
},
|
|
139
|
+
"kind": "action",
|
|
140
|
+
"method": "POST",
|
|
141
|
+
"path": "/api/v1/audiobooks/play",
|
|
142
|
+
"returns": {
|
|
143
|
+
"type": "null"
|
|
144
|
+
}
|
|
145
|
+
},
|
|
146
|
+
"restart": {
|
|
147
|
+
"args": {
|
|
148
|
+
"additionalProperties": false,
|
|
149
|
+
"properties": {
|
|
150
|
+
"book": {
|
|
151
|
+
"type": "string"
|
|
152
|
+
},
|
|
153
|
+
"source": {
|
|
154
|
+
"default": "local",
|
|
155
|
+
"type": "string"
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
"required": [
|
|
159
|
+
"book"
|
|
160
|
+
],
|
|
161
|
+
"type": "object"
|
|
162
|
+
},
|
|
163
|
+
"kind": "action",
|
|
164
|
+
"method": "POST",
|
|
165
|
+
"path": "/api/v1/audiobooks/restart",
|
|
166
|
+
"returns": {
|
|
167
|
+
"type": "null"
|
|
168
|
+
}
|
|
169
|
+
},
|
|
170
|
+
"set_finished": {
|
|
171
|
+
"args": {
|
|
172
|
+
"additionalProperties": false,
|
|
173
|
+
"properties": {
|
|
174
|
+
"book": {
|
|
175
|
+
"type": "string"
|
|
176
|
+
},
|
|
177
|
+
"finished": {
|
|
178
|
+
"default": true,
|
|
179
|
+
"type": "boolean"
|
|
180
|
+
},
|
|
181
|
+
"source": {
|
|
182
|
+
"default": "local",
|
|
183
|
+
"type": "string"
|
|
184
|
+
}
|
|
185
|
+
},
|
|
186
|
+
"required": [
|
|
187
|
+
"book"
|
|
188
|
+
],
|
|
189
|
+
"type": "object"
|
|
190
|
+
},
|
|
191
|
+
"kind": "action",
|
|
192
|
+
"method": "POST",
|
|
193
|
+
"path": "/api/v1/audiobooks/set_finished",
|
|
194
|
+
"returns": {
|
|
195
|
+
"type": "null"
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
},
|
|
199
|
+
"requires": {
|
|
200
|
+
"cache": null,
|
|
201
|
+
"library": null,
|
|
202
|
+
"player": null
|
|
203
|
+
}
|
|
204
|
+
}
|