Skip to content

Commit

Permalink
future3 V3.3 Release
Browse files Browse the repository at this point in the history
- Bookworm Support
- Documentation in Github (removed Sphinx and Readthedocs)
- Webapp Dependency updates
- Python Dependency updates
- Python venv
- Better Dockerfiles
- Installation fixes

Squashed commit of the following:

commit c0d5a20
Author: pabera <[email protected]>
Date:   Sat Nov 25 23:48:28 2023 +0100

    future3 V3.3 - reference webapp build (#2126)

commit 12f4f92
Author: Alvin Schiller <[email protected]>
Date:   Sat Nov 25 23:36:44 2023 +0100

    Future3/documentation (#2127)

    * fixed typo

    * restored "rpc-commands"

    * fixed broken links

    * switched placed for leading documentation

    * added docu for changing swap size

    * unified links to source

commit 924c7f3
Author: pabera <[email protected]>
Date:   Sat Nov 25 19:46:42 2023 +0100

    Remove content folder from docs (#2124)

commit 94aa9dc
Author: pabera <[email protected]>
Date:   Sat Nov 25 00:14:29 2023 +0100

    Future3/update docs (#2123)

    * Update pulseaudio link for docker mac setup

    * Update Docker docs

commit 2a0bb20
Author: pabera <[email protected]>
Date:   Fri Nov 24 23:24:29 2023 +0100

    Update some links in the documentation (#2122)

    * Update some links in the documentation

    * Rename docs folder userguide to builders

    * Update some headlines

commit dfb9e93
Author: Alvin Schiller <[email protected]>
Date:   Sat Nov 18 14:40:10 2023 +0100

    Cleanup installation messages (#2109)

    * cleanup installation messages

    use clear for each new option
    added headers
    use correct urls in finish message
    fixed some typos and wording

    * fix usage with multiple ip addresses (ipv4/ipv6)

    use single call to get all information during installation
    show and read out only first ip in webui

    * fix typo in translation

    * fix order for gateway / interface

    * harmonize read answer option

    * fix FIN_MESSAGE

    * fix line break on OS check

commit babb237
Author: s-martin <[email protected]>
Date:   Thu Nov 16 23:57:28 2023 +0100

    fix docker description for windows (#2114)

commit acf6ec0
Author: Alvin Schiller <[email protected]>
Date:   Thu Nov 16 22:49:57 2023 +0100

    Future3 fix venv usage (#2111)

    * fix node setup

    nodejs includes npm. fails on extra installation
    folder keyrings might not be created yet

    * install python packages via pip in venv

    * move venv to project root

    * remove outdated comments / messages about venv

    * remove hardwired path. replace during installation

    * fix dead variable

    * #2112 fix 'not tagged as plugin callable'

commit d62de5f
Merge: b7480b8 26ca404
Author: Simon <[email protected]>
Date:   Thu Nov 16 22:10:44 2023 +0100

    Merge branch 'future3/develop' of https://github.com/MiczFlor/RPi-Jukebox-RFID into future3/develop

commit b7480b8
Author: Simon <[email protected]>
Date:   Thu Nov 16 22:10:07 2023 +0100

    fix rename

commit 26ca404
Author: s-martin <[email protected]>
Date:   Thu Nov 16 22:06:23 2023 +0100

    * keep docs for template reader at src (#2113)

    * fix markdown warnings

commit e3bc59f
Author: s-martin <[email protected]>
Date:   Thu Nov 16 21:35:53 2023 +0100

    More links fixed (#2106)

    * fix link

    * fix links

    * fix indentation

    * fix link

    * fix links

    * fix links

    * fix link

    * Update template_reader.md

    * Make only link to docs

    * Fix link

    * Update and rename README.rst to README.md

    * Update and rename README.rst to README.md

    * Update and rename README.rst to README.md

    * Update and rename README.rst to README.md

commit b12c941
Author: s-martin <[email protected]>
Date:   Tue Nov 14 10:15:18 2023 +0100

    markdown file

commit 13bf5e5
Author: pabera <[email protected]>
Date:   Mon Nov 13 23:27:35 2023 +0100

    Future3/update dependencies (#2103)

    Update python venv
    Update Bookworm
    Update node to v20 (lts) and npm minor dependencies
    Update docker to all of the above

commit 1ca31dd
Author: s-martin <[email protected]>
Date:   Sun Nov 12 20:49:45 2023 +0100

    fix #2101 (#2107)

    * fix #2101

    * fix #2101 for de

commit 86d608c
Author: s-martin <[email protected]>
Date:   Sun Nov 12 12:31:13 2023 +0100

    fix some more doc links (#2105)

    * fix doc links

    * add a readme to user guide

    * add readme to developers section

    * fix links

    * fix some links

    * fix links

    * fix some links

    * fix links

    * fix links

    * fix links

    * fix links

    * fix links

    * add new line

commit b7743da
Author: Philipp S. Sommer <[email protected]>
Date:   Sun Nov 12 00:04:23 2023 +0100

    Fix future3 installation for bookworm (#2100)

    * add --break-system-packages option to pip3 install

    as required for bookworm, see #2050 (comment)

    * install libasound2-dev

    to fix installation of pyalsaaudio via pip3

    * install NodeJS and npm via official recommendation

    see https://github.com/nodesource/distributions

    * configure break-system-packages option globally

    see discussion in #2100 (review)

    * allow nginx (and others) to access /home/pi

commit 4667fc1
Author: s-martin <[email protected]>
Date:   Sat Nov 11 21:47:04 2023 +0100

    Fix link

commit 7406085
Author: s-martin <[email protected]>
Date:   Sat Nov 11 21:43:55 2023 +0100

    Fix link to feature status (#2102)

    * Fix link to feature status

    * Rename to-be-deleted-status.md to status.md

commit 1ca5a81
Author: pabera <[email protected]>
Date:   Sat Nov 11 21:26:19 2023 +0100

    future3 - Move docs back to Github & markdown (#2085)

    * Start moving docs to markdown

    * update userguide

    * add more pages

    * Rename index.md

    * Undo last commit

    * Add autohotspot

    * Finish userguide without references

    * Rename bt audio btns

    * Adding developers and rfid

    * docker: optimizations (#2074)

    - linux host: use pulse unix socket
    - mpd: run as user (pi / root)
    - mpd: remove port exposure to host, connections to mpd only come from other docker containers
    - less config adjustments for docker environment

    Co-authored-by: Christoph Lauer <[email protected]>

    * Start moving docs to markdown

    * update userguide

    * add more pages

    * Rename index.md

    * Undo last commit

    * Add autohotspot

    * Finish userguide without references

    * Rename bt audio btns

    * Adding developers and rfid

    * Rename docs to documentation

    * Update document structure

    * Move rfid to developers

    * Remove sphinx

    * Remove even more sphinx

    * Test pydoc

    * Revert "Test pydoc"

    This reverts commit e1c6aeb.

    Revert "Remove even more sphinx"

    This reverts commit 6f55597.

    Revert "Remove sphinx"

    This reverts commit 23abee3.

    * Moving sphinx for api and command reference

    * Remove Sphinx for good

    * update paths to developers

    ---------

    Co-authored-by: notapirate <[email protected]>
    Co-authored-by: Christoph Lauer <[email protected]>

commit 0660586
Author: Christian Tietze <[email protected]>
Date:   Wed Nov 8 17:01:23 2023 +0100

    Remove unused _jukebox_core_download_prebuilt_pyzmq (#2097)

    See report #2094

commit 373fd38
Author: Christian Tietze <[email protected]>
Date:   Wed Nov 8 17:00:48 2023 +0100

    Fix pyzmq installation from source with drafts support (#2096)

    * Fix pyzmq installation from source with drafts support

    * Update pyzmq docs link

commit 5e35ce8
Author: notapirate <[email protected]>
Date:   Fri Nov 3 14:33:56 2023 +0100

    docker: optimizations (#2074)

    - linux host: use pulse unix socket
    - mpd: run as user (pi / root)
    - mpd: remove port exposure to host, connections to mpd only come from other docker containers
    - less config adjustments for docker environment

    Co-authored-by: Christoph Lauer <[email protected]>

commit 6f1efb8
Author: Alvin Schiller <[email protected]>
Date:   Tue Oct 10 21:21:59 2023 +0200

    fix unavailable repo for pi-rc522 (#2075)

    * fix unavailable repo for pi-rc522. Use fix version to ensure compatibility

    * build trigger

    * REVERT build trigger

    * fixed sphinx gpiozero version for pyton < 3.8

    * fixed sphinx gpiozero version for pyton >= 3.8

commit f803185
Author: Alvin Schiller <[email protected]>
Date:   Tue Oct 10 21:15:54 2023 +0200

    future3: Abort installation if user is not "pi" (#2077)

    * check for user 'pi' and home '/home/pi'

    retrieve correct information even if called with sudo

    * removed obsolete v2.x workflow files

commit b11606a
Author: s-martin <[email protected]>
Date:   Sat Sep 2 12:51:56 2023 +0200

    Create dependabot.yml (#2022)

commit 99a5536
Author: pabera <[email protected]>
Date:   Tue Aug 15 00:25:41 2023 +0200

    Add info to install script and documentation about 64bit systems #2041 (#2057)

    * Add info to install script and documentation about 64bit systems #2041

    * Fix flake8 error

commit 37a7938
Author: Alvin Schiller <[email protected]>
Date:   Fri May 5 09:02:36 2023 +0200

    set indent_size of 2 for js and yaml files (#2026)

commit 99bad28
Author: Alvin Schiller <[email protected]>
Date:   Wed May 3 23:30:01 2023 +0200

    future3 - Feature "sync shared" (#2009)

    * first callback test

    * default sync_shared settings added

    * moved test callback methods

    * fixed logger call

    * changed logger name

    * test rpc call sync_folder

    * settings added

    * added test rsync call (subprocess)

    * fixed path

    * fixed paths

    * fixed errorlogging

    * changed subprocess shell=false

    * added player update

    * fixed subprocess args

    * fixed rsync parameter

    * update database on caller. added return value

    * added "wait for database update"

    * added server and directory checks
    loglevels adjusted

    * fixed sync for subfolder shortcuts

    * fixed ignored files

    * refactored path handling
    use os.path instead of string concatenation
    fixed handling for abs path folder name

    * refactored logic in control class

    * added check for "on_rfid_scan_enabled"

    * sync_full added

    * added check for feature activation

    * correction of bool value handling
    evaluate to false if settings not correctly set (e.g. as string)

    * fix flake8 errors

    * update log message and fix result code

    * added ssh support

    * refactored paths for run_params

    * speed up ssh mode
    perform less checks for folder existence

    * added sync_change_on_rfid_scan

    * updated default settings
    format like ConfigHandler would save it

    * added command binding for Ui

    * fixed binding of command options
    and made them lowercase

    * changed invalid parameter handling

    * added sync_card_database

    update card id only on rfid scan sync
    overwrite on full sync

    * refactorings

    added locking on cfg access
    updated methodnames
    updated logging
    methods reordered
    flake8 corrections

    * exclude folder.conf if existing from V2.x

    * changed call on rfid scan to callback

    * fix flake8 errors

    * fix indendation for JS

    * combine settings of credentials for modes

    * naming convention

    * refactored function names to be more clear

    * changed options of sync_change_on_rfid_scan

    options changed from  "true"/"false" to "enable"/"disable"

    * moved identical prechecks to functions

    * renamed "sync_full" to "sync_all"

    * Fix function calls

    fix for: moved identical prechecks to functions

    * renamed "sync_full" to "sync_all"

    correction for logging

    * added "update_wait" and fixed to much locking

    * changed call on play_card to callback

    * changed precheck names to "is sync enabled"

    * updated function names "is_file" and "is_dir"

    * reduced nesting complexity

    * Changed rfid callback state to Enum

    renamed callback class
    add state as enum

    * Changed playcontent callback state to Enum

    added state as num
    moved callback and enum to seperate class
    callback class with generic to be able to use in more play functions

    * fix import

    * fixed generic type definition

    * harmonised precheck for sync_change_on_rfid_scan

    * refactored methods to util class

    * renamed syncutil to syncutils. fixed import

    * fixed flake8

    * Moved syncutils up

    * renamed module sync_shared to rfidcards

    * renamed sync_shared to sync_rfidcards

    * fix flake8

    * updated documentation

    * Updated translation for en

    * Updated language

    * Updated language

    * Update docs

    ---------

    Co-authored-by: pabera <[email protected]>

commit 8eee27b
Author: Michael Weinrich <[email protected]>
Date:   Sun Apr 16 17:13:25 2023 +0200

    Fix typo in System Setup chapter (#2012)

commit 68138d1
Author: pabera <[email protected]>
Date:   Wed Apr 12 23:41:31 2023 +0200

    update webapp dependencies (#2010)

commit 0250733
Author: Alvin Schiller <[email protected]>
Date:   Wed Apr 12 07:12:57 2023 +0200

    Fix Workflow Actions flake8 (future3) (#1989)

    * flake8 Version pin >= 4.0.0

    * flake8 corrections

    * update action versions

    * Updated pyton version matrix

    Pythen versions 3.7 - 3.11 added
    add quotation for correct intpretation

commit a8c56b0
Author: notapirate <[email protected]>
Date:   Fri Apr 7 23:43:28 2023 +0200

    setup_jukebox_core.sh: fix pyzmq installation for current pip versions (#1928)

    - using --install-options is deprecated, building pyzmq throws an error
    - use environment variables instead to activate draft support

    Co-authored-by: Christoph <Christoph Lauer>

commit 6fce216
Author: kugelzucker <[email protected]>
Date:   Fri Apr 7 23:37:35 2023 +0200

    a few more typos and wordings (#1952)

    * typos

    * GPIOs listed as unsupported

    is this still true? i used gpio on future3 and it seems fine. if its obsolete then merge.

    * typos and wording

    * typos, wording

    * info about tail -f on installlog

    * added info about monitoring install log

    * tail -f INSTALL-log,with proper formating

    * wording

    * wording

commit 0326c9a
Author: s-martin <[email protected]>
Date:   Tue Jan 3 14:26:31 2023 +0100

    Fix count in flake8 config (#1954)

commit 5734440
Author: kugelzucker <[email protected]>
Date:   Mon Jan 2 10:11:41 2023 +0100

    typos in docs (#1950)

    typo and broken link to phoniebox.de, site seems down right now.
  • Loading branch information
pabera committed Nov 25, 2023
1 parent bd7bb78 commit 36df0f0
Show file tree
Hide file tree
Showing 173 changed files with 10,544 additions and 22,196 deletions.
3 changes: 2 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
.git
.githooks
.github
.dockerignore
.DS_Store

# Application
docker
docs
installation
src
shared

# webapp
Expand Down
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@ indent_size = 4

[*.md]
trim_trailing_whitespace = false

[*.{js,yaml}]
indent_size = 2
4 changes: 1 addition & 3 deletions .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,13 @@ per-file-ignores =
# Not necessary, if __all__ is declared in __init__ file
# https://www.python.org/dev/peps/pep-0008/#id48
__init__.py:F401
count
count = True
max-complexity = 12
statistics = True
filename = *.py,*.py.*
extend-exclude =
# Ignore all scratch development directories
scratch*,
# The conf file is mostly autogenerated, ignore it
docs/sphinx/conf.py,
# Ignore dirs and files that have not been ported yet
*/jukebox/NvManager.py
# ignore GitHub Codespaces
Expand Down
2 changes: 1 addition & 1 deletion .githooks/post-merge
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ warn_python_requirements() {
echo "ATTENTION: Python requirements have changed since last pull!"
echo ""
echo "To update python requirements on the RPi run"
echo "$ sudo python3 -m pip install --upgrade -r requirements.txt"
echo "$ python -m pip install --upgrade -r requirements.txt"
echo "************************************************************"
echo -e "\n"
}
Expand Down
13 changes: 1 addition & 12 deletions .githooks/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,7 @@ if [[ -n $PY_FILES ]]; then
echo "Flake8 return code: $flake8_code"
fi

DOC_FILES="$(git diff --diff-filter=d --staged --name-only -- docs/sphinx/*)"
sphinx_code=0
if [[ -n $DOC_FILES || -n $PY_FILES ]]; then
echo -e "\n**************************************************************"
echo -e "Files for documentation modified. Testing re-build of docs ... \n"
echo -e "**************************************************************\n"
./run_sphinx.sh -c
sphinx_code=$?
echo "Sphinx return code: $sphinx_code"
fi

code=$(( flake8_code + sphinx_code ))
code=$(( flake8_code ))

if [[ code -gt 0 ]]; then
echo -e "\n**************************************************************"
Expand Down
26 changes: 26 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "monthly"

- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "monthly"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"

- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "monthly"
21 changes: 0 additions & 21 deletions .github/workflows/dockerimage.yml

This file was deleted.

40 changes: 0 additions & 40 deletions .github/workflows/pythonpackage.yml

This file was deleted.

19 changes: 3 additions & 16 deletions .github/workflows/pythonpackage_future3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@ on:
paths:
- '**.py'
- '**.py.*'
- 'docs/sphinx/**'
pull_request:
branches:
- 'future3/**'
paths:
- '**.py'
- '**.py.*'
- 'docs/sphinx/**'

jobs:
build:
Expand All @@ -23,26 +21,21 @@ jobs:
strategy:
max-parallel: 4
matrix:
python-version: [3.7, 3.9]
python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']

steps:
- uses: actions/checkout@v1
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y libasound2-dev pulseaudio
python3 -m pip install --upgrade pip
pip3 install wheel
pip3 install spidev
pip3 install -r requirements.txt
# For operation of the Jukebox, ZMQ must be compiled from sources due to Websocket support
# When just building the docs, the regular ZMQ package is sufficient
pip3 install -r docs/sphinx/requirements_pyzmq.txt
pip3 install -r docs/sphinx/requirements.txt
# Also install all optional dependencies
pip3 install -r src/jukebox/components/rfid/hardware/fake_reader_gui/requirements.txt
pip3 install -r src/jukebox/components/rfid/hardware/pn532_i2c_py532/requirements.txt
Expand All @@ -53,9 +46,3 @@ jobs:
pip3 install flake8
# Stop the build if linting fails
./run_flake8.sh
- name: Build the docs
working-directory: ./docs/sphinx
run: |
# Stop the build if documentation cannot be built
# Treat all warnings as errors
sphinx-build -W --keep-going -T -a -E -b html . _build
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@
/shared/*.*
/shared/*

# Documentation builder
/docs/sphinx/_build/

# Application
/src/cli_client/pbc

Expand Down
28 changes: 0 additions & 28 deletions .readthedocs.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <[email protected]>. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Expand Down
15 changes: 0 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ The Jukebox core app is written entirely in Python. Therefore, we follow the [Py

* **Documentation**
* You are expected to write some Documentation. It's easy. **Very** easy actually with [Python Docstrings](https://www.geeksforgeeks.org/python-docstrings/)
* If you dare, you may add the python documentation reference to the Sphinx documentation build. But we are also ok with doing that for you

# Structure of files and folders

Expand All @@ -38,8 +37,6 @@ Inside the root folder or the repo, these folders are important:
* contains the Python packages that are loaded using the plugin interface
* `src/webapp`
* contains the Web Interface
* `src/docs/sphinx`
* contains the documentation sources and build flow using Sphinx

All folders on all hierarchy levels starting with `scratch*` are ignored by git and flake8. These are intended
as local, temporary scratch areas.
Expand Down Expand Up @@ -132,18 +129,6 @@ cd /home/pi/RPi-Jukebox-RFID
If you are convinced some issue should not apply to your case or would require extensive re-coding, that could be OK.
Let us know in the pull request - we will look at it.
### Documentation
When adding or improving documentation, build the documentation and look at it locally.
If you are contributing to existing Python modules, be aware that these are already included in the documentation flow.
Also run through this step in this case! Fix all warnings!
~~~bash
$ cd /home/pi/RPi-Jukebox-RFID/
$ ./run_sphinx.sh
# open and check the result: 'file:///path/to/RPi-Jukebox-RFID/docs/sphinx/_build/html/index.html'
~~~
### Tests
Tests are very few at the moment, but it cannot hurt to run them. If you have tests for your new modules, please add
Expand Down
21 changes: 1 addition & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# RFID Jukebox Version 3 (aka future3)

[![Documentation Status](https://readthedocs.org/projects/rpi-jukebox-rfid/badge/?version=latest)](https://rpi-jukebox-rfid.readthedocs.io/en/latest/?badge=latest)

## What is this?

The exiting, new **Version 3** of the RPi Jukebox RFID. A complete re-write of the Jukebox.
Expand All @@ -11,24 +9,7 @@ project check out the [documentation of Version 2](<https://github.com/MiczFlor/

## Where are the Help pages?

### Online

Read the documentation at [Readthedocs.io](https://rpi-jukebox-rfid.readthedocs.io/en/latest/)

### Local

Alternatively, build the help locally:

~~~bash
cd docs/sphinx
make
~~~

Then navigate your browser to

~~~bash
file:///path/to/RPi-Jukebox-RFID/docs/sphinx/_build/html/docs/index.html
~~~
The documentation can be found [here](./documentation/README.md)

## Installation?

Expand Down
Loading

0 comments on commit 36df0f0

Please sign in to comment.