Support version 5.1.0 #345

felddy · 2024-05-25T02:55:29Z

🗣 Description

Support WeeWX v5.1.0

💭 Motivation and context

It seems people are interested, and I've finally found a few spare cycles to continue the work.
Also, I'd like to get it working with my Home Assistant setup. ;)

🧪 Testing

✅ Pre-approval checklist

This PR has an informative and human-readable title.
Changes are limited to a single goal - eschew scope creep!
All future TODOs are captured in issues, which are referenced
in code comments.
All relevant type-of-change labels have been added.
I have read the CONTRIBUTING document.
These code changes follow cisagov code standards.
All relevant repo and/or project documentation has been updated
to reflect the changes in this PR.
Tests have been added and/or modified to cover the changes in this PR.
All new and existing tests pass.

✅ Pre-merge checklist

Revert dependencies to default branches.
Finalize version.

✅ Post-merge checklist

Add a tag or create a release.

Dockerfile

bourquep · 2024-10-28T13:29:40Z

I'd love to see weewx-docker support weewx v5, is there anything I can do to help?

ThomDietrich · 2024-11-05T12:01:45Z

Hey @felddy, same question. Are you still dedicated to push this project? I think there are many interested users and willing contributors.

mbwhite · 2024-11-23T11:32:27Z

Hello; I'm migrating weewx to a new machine and wanted to use docker.

Happy to help...

Just running a build myself on my own fork - I notice that the extensions have been removed.. wondering if any specific reason...

felddy · 2024-11-25T22:49:52Z

Hey everyone. I appreciate your interest and patience.

I've made a great deal of progress fighting the bit rot. I'm running through testing now, and making sure I've covered some of the common use cases I know about.

I hope to have a release out in the next few days. If you're either impatient or brave you can try pulling the images that are being generated by GitHub Actions for the PR at: felddy/weewx:release-5.0.2

Note

I'm targeting version 5.1.0 for this PR even though the branch is named 5.0.2. Renaming the branch would close the PR.

Stay tuned...

This should be installed via an extension going forward

mbwhite · 2024-11-26T07:33:39Z

Thanks @felddy I was running the PR over the weekend, most issues where related to me getting the SDR to work.
Generally though stable and working !

Thanks again:

Update confirmed that the reporting update is not connected to the docker image.

mbwhite · 2024-11-30T18:57:56Z

@felddy all seems well with the image, with one exception. I've found that I needed to rebuild the base image supplying the uid I need weewx to run under. Just supplying this at runtime didn't work as there was no user of that id inside the image

leaberry · 2024-12-02T20:48:16Z

I have the same comment as @mbwhite, it's missing something that allows for user switching.

Dec  2 20:45:47 syslogd started: BusyBox v1.35.0
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Initializing weewxd version 5.1.0
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Command line: /opt/venv/bin/weewxd --config /data/weewx.conf
Dec  2 20:45:48 weewxd[20]: ERROR weeutil.startup: Cannot load user extensions: No module named 'user'
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Using Python: 3.13.0 (main, Nov 12 2024, 02:27:08) [GCC 12.2.0]
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Located at:   /opt/venv/bin/python
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Platform:     Linux-6.8.0-49-generic-x86_64-with-glibc2.36
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Locale:       'LC_CTYPE=C.UTF-8;LC_NUMERIC=C;LC_TIME=C;LC_COLLATE=C;LC_MONETARY=C;LC_MESSAGES=C;LC_PAPER=C;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=C;LC_IDENTIFICATION=C'
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Entry path:   /opt/venv/bin/weewxd
Dec  2 20:45:48 weewxd[20]: INFO weewxd: WEEWX_ROOT:   /data
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Config file:  /data/weewx.conf
Dec  2 20:45:48 weewxd[20]: INFO weewxd: User module:  /data/bin/user
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Debug:        1
Dec  2 20:45:48 weewxd[20]: INFO weewxd: User unavailable: 'getpwuid(): uid not found: 2000'
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Groups unavailable: 'getgrgid(): gid not found: 2000'
Dec  2 20:45:48 weewxd[20]: DEBUG weewxd: loop_on_init: False
Dec  2 20:45:48 weewxd[20]: DEBUG weewxd: Initializing engine
Dec  2 20:45:48 weewxd[20]: INFO weewx.engine: Loading station type Interceptor (user.interceptor)
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd: Caught unrecoverable exception:
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****  No module named 'user'
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****  Traceback (most recent call last):
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****    File "/opt/venv/lib/python3.13/site-packages/weewxd.py", line 121, in main
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****      engine = weewx.engine.StdEngine(config_dict)
Using configuration file /data/weewx.conf
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****    File "/opt/venv/lib/python3.13/site-packages/weewx/engine.py", line 80, in __init__
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****      self.setupStation(config_dict)
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****      ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****    File "/opt/venv/lib/python3.13/site-packages/weewx/engine.py", line 104, in setupStation
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****      __import__(driver)
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****      ~~~~~~~~~~^^^^^^^^
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****  ModuleNotFoundError: No module named 'user'
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****  Exiting.
Traceback (most recent call last):
  File "/opt/venv/bin/weewxd", line 8, in <module>
    sys.exit(main())
             ~~~~^^
  File "/opt/venv/lib/python3.13/site-packages/weewxd.py", line 121, in main
    engine = weewx.engine.StdEngine(config_dict)
  File "/opt/venv/lib/python3.13/site-packages/weewx/engine.py", line 80, in __init__
    self.setupStation(config_dict)
    ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
  File "/opt/venv/lib/python3.13/site-packages/weewx/engine.py", line 104, in setupStation
    __import__(driver)
    ~~~~~~~~~~^^^^^^^^
ModuleNotFoundError: No module named 'user'
Switching uid:gid to 2000:2000```

felddy · 2024-12-03T23:22:03Z

@felddy all seems well with the image, with one exception. I've found that I needed to rebuild the base image supplying the uid I need weewx to run under. Just supplying this at runtime didn't work as there was no user of that id inside the image

@mbwhite I'm looking into the uid/gid issue. As a workaround for now you can set the USERNAME environment variable in your docker-compose file. USERNAME: weewx is working for me.

felddy · 2024-12-03T23:24:04Z

I have the same comment as @mbwhite, it's missing something that allows for user switching.

@leaberry I believe this is unrelated. You have missing extensions referenced in your configuration: user.interceptor

By properly configuring the logging options of WeeWX to send to the console, we can remove all the code that was required to run as root and the drop to a different user.

mbwhite · 2024-12-04T20:08:45Z

@felddy all seems well with the image, with one exception. I've found that I needed to rebuild the base image supplying the uid I need weewx to run under. Just supplying this at runtime didn't work as there was no user of that id inside the image

@mbwhite I'm looking into the uid/gid issue. As a workaround for now you can set the USERNAME environment variable in your docker-compose file. USERNAME: weewx is working for me.

It's the actual ID of the user that that I need to match. Thev data directory is mounted and if to avoid those been written out as a user I don't have on the host system.

I also need to add in extra libraries to get the SDR to work. See https://github.com/ampretia/womble-weewx

mbwhite · 2024-12-04T20:10:13Z

I have the same comment as @mbwhite, it's missing something that allows for user switching.

Dec  2 20:45:47 syslogd started: BusyBox v1.35.0
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Initializing weewxd version 5.1.0
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Command line: /opt/venv/bin/weewxd --config /data/weewx.conf
Dec  2 20:45:48 weewxd[20]: ERROR weeutil.startup: Cannot load user extensions: No module named 'user'
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Using Python: 3.13.0 (main, Nov 12 2024, 02:27:08) [GCC 12.2.0]
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Located at:   /opt/venv/bin/python
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Platform:     Linux-6.8.0-49-generic-x86_64-with-glibc2.36
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Locale:       'LC_CTYPE=C.UTF-8;LC_NUMERIC=C;LC_TIME=C;LC_COLLATE=C;LC_MONETARY=C;LC_MESSAGES=C;LC_PAPER=C;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=C;LC_IDENTIFICATION=C'
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Entry path:   /opt/venv/bin/weewxd
Dec  2 20:45:48 weewxd[20]: INFO weewxd: WEEWX_ROOT:   /data
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Config file:  /data/weewx.conf
Dec  2 20:45:48 weewxd[20]: INFO weewxd: User module:  /data/bin/user
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Debug:        1
Dec  2 20:45:48 weewxd[20]: INFO weewxd: User unavailable: 'getpwuid(): uid not found: 2000'
Dec  2 20:45:48 weewxd[20]: INFO weewxd: Groups unavailable: 'getgrgid(): gid not found: 2000'
Dec  2 20:45:48 weewxd[20]: DEBUG weewxd: loop_on_init: False
Dec  2 20:45:48 weewxd[20]: DEBUG weewxd: Initializing engine
Dec  2 20:45:48 weewxd[20]: INFO weewx.engine: Loading station type Interceptor (user.interceptor)
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd: Caught unrecoverable exception:
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****  No module named 'user'
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****  Traceback (most recent call last):
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****    File "/opt/venv/lib/python3.13/site-packages/weewxd.py", line 121, in main
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****      engine = weewx.engine.StdEngine(config_dict)
Using configuration file /data/weewx.conf
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****    File "/opt/venv/lib/python3.13/site-packages/weewx/engine.py", line 80, in __init__
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****      self.setupStation(config_dict)
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****      ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****    File "/opt/venv/lib/python3.13/site-packages/weewx/engine.py", line 104, in setupStation
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****      __import__(driver)
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****      ~~~~~~~~~~^^^^^^^^
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****  ModuleNotFoundError: No module named 'user'
Dec  2 20:45:48 weewxd[20]: CRITICAL weewxd:     ****  Exiting.
Traceback (most recent call last):
  File "/opt/venv/bin/weewxd", line 8, in <module>
    sys.exit(main())
             ~~~~^^
  File "/opt/venv/lib/python3.13/site-packages/weewxd.py", line 121, in main
    engine = weewx.engine.StdEngine(config_dict)
  File "/opt/venv/lib/python3.13/site-packages/weewx/engine.py", line 80, in __init__
    self.setupStation(config_dict)
    ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
  File "/opt/venv/lib/python3.13/site-packages/weewx/engine.py", line 104, in setupStation
    __import__(driver)
    ~~~~~~~~~~^^^^^^^^
ModuleNotFoundError: No module named 'user'
Switching uid:gid to 2000:2000```

I think there's something else going on there as well as the uid gid...

felddy · 2024-12-04T20:22:35Z

It's the actual ID of the user that that I need to match. Thev data directory is mounted and if to avoid those been written out as a user I don't have on the host system.

I also need to add in extra libraries to get the SDR to work. See https://github.com/ampretia/womble-weewx

A new build was published by CI/CD that you should pull.

I've was able to simplify to the container's user management by removing the need for syslog and configuring WeeWX to use the console. Adding a user line to my docker-compose allowed me to get the correct user and group configured.

---
services:
  weewx:
    image: ghcr.io/felddy/weewx:release-5.0.2
    user: 1001:dialout
    volumes:
      - type: bind
        source: ./data
        target: /data
    devices:
      - /dev/ttyUSB0

You'll also need to configure the console logging with:

[Logging]
    [[root]]
        level = INFO
        handlers = console,

As for the SDR library. If it had been Python you can install it with:
docker compose run --rm --entrypoint pip weewx install <library-name>

And it would be saved on your data volumes Python path. Since you're bringing it in with apt-get, your approach is probably best.

Let me know if this works for you.

Closes #290

…dations

…ackages

felddy self-assigned this May 25, 2024

ThomDietrich reviewed Jun 30, 2024

View reviewed changes

Dockerfile Outdated Show resolved Hide resolved

felddy force-pushed the release/5.0.2 branch 2 times, most recently from 4c1e8e2 to cbb7789 Compare November 25, 2024 21:25

felddy changed the title ~~Release/5.0.2~~ Support version 5.1.0 Nov 25, 2024

felddy added dependencies 🎲 docker 🐳 documentation 📝 enhancement ✨ feature request 💡 upstream 👀 labels Nov 25, 2024

felddy added 15 commits November 25, 2024 17:56

Bump _version.py from 4.10.2 to 5.0.2

50a98d9

Bump Python version requirement to 3.12

938ea70

Remove paho-mqtt

24c7cdc

This should be installed via an extension going forward

Update setup.py with weewx dependency

86b85ff

Update Dockerfile to support new availability of weewx in pip

0154010

Clean up docker-compose file

9550c7c

Convert entrypoint to support weewx v5

dbb0d0f

Bump WEEWX_VERSION from 4.10.2 to 5.0.2

4bbdff1

Bump WeeWX version to 5.1

e5ceab2

Update example docker compose config

159f8a7

Document how to add extensions

3694342

Update Python version requirement to 3.13

9db3a96

Add missing version declaration

75ae335

Add PYTHONPATH to data volume

602276b

Remove unused file from v4 implementation

dd25129

felddy added 2 commits November 25, 2024 17:56

Update documentation with new procedures

5f6561d

Remove duplicate diagnostics job

55c0fa4

felddy force-pushed the release/5.0.2 branch from b1aa0a1 to 55c0fa4 Compare November 25, 2024 22:57

felddy added 3 commits December 4, 2024 13:30

Simplify user permissions

395d840

By properly configuring the logging options of WeeWX to send to the console, we can remove all the code that was required to run as root and the drop to a different user.

Migrate setup.py to pyproject.toml

93e1d09

Align documentation with reality

0a49edd

felddy force-pushed the release/5.0.2 branch from ce07400 to 0a49edd Compare December 4, 2024 19:03

Loosen Python restriction for linter workflow

ff4bc52

felddy added 8 commits December 27, 2024 13:54

Remove unnecessary volume declaration

7cb9886

Fix indentation in logging configuration

27fecb6

Add 'ephem' to dependencies

5dc6dac

Closes #290

Use full length CLI flags

7fa642f

Update README to include image tagging information and usage recommen…

8476cae

…dations

Add git installation to Dockerfile dependencies

0fa8b92

Update README to clarify migration steps and installation of Python p…

416e0f7

…ackages

Format command for better readability

a961f0f

felddy marked this pull request as ready for review December 28, 2024 23:34

felddy merged commit ac858a6 into develop Dec 28, 2024
34 checks passed

felddy deleted the release/5.0.2 branch December 28, 2024 23:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support version 5.1.0 #345

Support version 5.1.0 #345

felddy commented May 25, 2024 •

edited

Loading

bourquep commented Oct 28, 2024

ThomDietrich commented Nov 5, 2024

mbwhite commented Nov 23, 2024 •

edited

Loading

felddy commented Nov 25, 2024

mbwhite commented Nov 26, 2024 •

edited

Loading

mbwhite commented Nov 30, 2024

leaberry commented Dec 2, 2024

felddy commented Dec 3, 2024

felddy commented Dec 3, 2024

mbwhite commented Dec 4, 2024

mbwhite commented Dec 4, 2024

felddy commented Dec 4, 2024

Support version 5.1.0 #345

Support version 5.1.0 #345

Conversation

felddy commented May 25, 2024 • edited Loading

🗣 Description

💭 Motivation and context

🧪 Testing

✅ Pre-approval checklist

✅ Pre-merge checklist

✅ Post-merge checklist

bourquep commented Oct 28, 2024

ThomDietrich commented Nov 5, 2024

mbwhite commented Nov 23, 2024 • edited Loading

felddy commented Nov 25, 2024

mbwhite commented Nov 26, 2024 • edited Loading

mbwhite commented Nov 30, 2024

leaberry commented Dec 2, 2024

felddy commented Dec 3, 2024

felddy commented Dec 3, 2024

mbwhite commented Dec 4, 2024

mbwhite commented Dec 4, 2024

felddy commented Dec 4, 2024

felddy commented May 25, 2024 •

edited

Loading

mbwhite commented Nov 23, 2024 •

edited

Loading

mbwhite commented Nov 26, 2024 •

edited

Loading