FreeBSD support #1836

MuhammadMuradG · 2023-03-31T00:17:43Z

Describe your changes in detail

This PR add support to Freebsd13. As the Freebsd is an unix-like OS and could use gtk, it can be used with toga with just few edits to the toga code base.

For consistency, this PR changed the linux backend name to Unix-like, which make sense to any platform that is not linux but using gtk3.

What problem does this change solve?

This PR make Toga possible on Freebsd13 😄.

PR Checklist:

All new features have been tested
All new features have been documented
I have read the CONTRIBUTING.md file
I will abide by the code of conduct

freakboy3742

I don't have any objection adding the internal tooling to support use of FreeBSD; however, I'm not going to degrade the user experience for the larger Linux user base to accomodate it. Comments inline.

freakboy3742 · 2023-03-31T00:26:45Z

changes/1836.feature.rst

@@ -0,0 +1 @@
+Add support to Freebsd13 OS.


We try really hard to follow style guides when referring to other operating systems in user-facing text - I'm pretty sure this should be FreeBSD. Also - given FreeBSD12 isn't EOL, and FreeBSD14 is on the horizon - is there any reason to narrow this to v13 specifically?

Oh, you are right, this should be FreeBSD.

The main reason is that I'm tested it on v13, and I don't want to add version that I didn't test it. Also, I don't want to see, in the future, a list of 'How to install Toga in different FreeBSD versions', so I preferred to maintaining only last FreeBSD release, especially since FreeBSD is a rolling release OS. However, I suggest to remove the version returned by the sys.platform to be just freebsd.

freakboy3742 · 2023-03-31T00:27:16Z

core/setup.cfg

@@ -45,6 +45,8 @@ keywords =
    android
    windows
    winforms
+	unix-like
+	freebsd


Indentation is inconsistent here. Also "Unix-like" is a near meaningless term. Android and macOS are both "unix like".

The inconsistent here because I used tab instead of spaces. The fix will be committed.

Because, Toga now support big number of unix-like OS I add it to keywords in metadata. Also, since keywords are used to assist searching for the distribution in a larger catalog, I expected this will help. Is it?

freakboy3742 · 2023-03-31T00:30:00Z

core/src/toga/platform.py

@@ -20,7 +20,8 @@
    "android": "android",
    "darwin": "macOS",
    "ios": "iOS",
-    "linux": "linux",
+    "linux": "UnixLike",
+    "freebsd13": "UnixLike",


This breaks backwards compatibility for existing code that is expecting "linux" as the toga platform.

The right approach here is to add a mapping for freebsd13 to freebsd (or, to freebsd13 if you think there's a need to differentiate versions in a Toga context; I can't say I know FreeBSD well enough to comment on whether this is the case). Adding mappings for 12 and 14 would also make sense.

The changes addressed into the following commits, with removing the freebsd version.

freakboy3742 · 2023-03-31T00:32:13Z

docs/how-to/contribute-code.rst

@@ -31,7 +31,7 @@ First thing is to ensure that you have Python 3 and pip installed. To do this ru
      $ python3 --version
      $ pip3 --version

-  .. group-tab:: Linux
+  .. group-tab:: Unix-like


Unix-like is a near meaningless term, and one that only serves to confuse inexperienced Linux users. FreeBSD use is sufficiently niche that I'm comfortable expecting FreeBSD users to work out that their commands are close enough to Linux that they can adapt.

I'm just conservative about referring to FreeBSD into Linux instructions. Is it possible to add new tab with name *BSD which may be add the possibility in the future to support other *BSD platforms like OpenBSD, GhostBSD and etc?

...and I'm telling you that I've been working on this project for almost 8 years, and in that entire time, you're the first person who has asked for FreeBSD support. I haven't had any requests for other BSDs (or any other Unix, for that matter).

I hate to break it to you, but non-Linux Unix platforms are niche. FWIW, Linux usage is pretty niche as well - but it's a lot more common than non-Linux Unix, and I'm not convinced that all Linux users actually know that they're running a "Unix-like" operating system. Many do - but you'd be surprised the sorts of questions we get from users.

I'm also not wild about adding a second tab, since the instructions will be exactly the same, so you're adding a maintenance burden to the core team and all other contributors for the benefit of, so far, exactly 1 user.

If FreeBSD users are going to start complaining that the best match for their usage instructions are listed under Linux, not "Unix", then I'm more than willing to offer them a 100% refund of their purchase price.

freakboy3742 · 2023-03-31T00:34:42Z

docs/how-to/contribute-code.rst


    .. code-block:: bash

+      # Freebsd13
+      (venv) $ sudo pkg update
+      (venv) $ sudo pkg install gtk3 gobject-introspection cairo webkit2-gtk3


FreeBSD, not Freebsd

Is there any reason to believe this set of instructions won't also be true for FreeBSD12 and 14? Could this just be FreeBSD, not FreeBSD 13

From a UX perspective, FreeBSD should be last in this list of instructions, not first.

This list should also include anything needed to install a version of Python that can be used for development purposes.

Regarding to the points 1 and 4 I will address it in the next commits.

For 2 and 3, see the previous inline comments.

I'm not I see sure you your previous comments address 2 and 3. Your other commits introduce compatibility with FreeBSD 12/14, but these docs still explicitly say 13 (point 2); and they're still at the top of the list of Unix options (point 3).

Sorry, I dropped the comments for 2 and 3, however the next commit will address them.

freakboy3742 · 2023-03-31T00:35:11Z

docs/tutorial/tutorial-0.rst

@@ -71,6 +71,10 @@ Next, install Toga into your virtual environment:

    .. code-block:: bash

+      # Freebsd13
+      (venv) $ sudo pkg update
+      (venv) $ sudo pkg install gtk3 gobject-introspection cairo webkit2-gtk3


See notes above about these install instructions.

freakboy3742 · 2023-03-31T00:35:24Z

gtk/setup.cfg

@@ -38,6 +38,8 @@ keywords =
    cross-platform
    toga
    desktop
+	unix-like
+	freebsd


See previous notes about indentation and unix-like

freakboy3742 · 2023-03-31T00:36:05Z

gtk/setup.cfg

@@ -50,7 +52,7 @@ zip_safe = False

 [options.entry_points]
 toga.backends =
-    linux = toga_gtk
+    UnixLike = toga_gtk


Registering a backend costs nothing; this should 2 independent linux and freebsd registrations.

freakboy3742 · 2023-03-31T00:36:12Z

toga/setup.cfg

@@ -45,6 +45,8 @@ keywords =
    android
    windows
    winforms
+	Unix-like
+	freebsd


See previous comments.

freakboy3742 · 2023-03-31T00:36:34Z

toga/setup.py

@@ -8,6 +8,7 @@
    extras_require={
        # Automatically installed platform backends
        ':sys_platform=="win32"': ["toga-winforms==%s" % version],
+        ':sys_platform=="freebsd13"': ["toga-gtk==%s" % version],


Compatibility with 12 and 14 again.

freakboy3742 · 2023-04-01T00:38:20Z

README.rst

+* If you're on Unix-like, you need to have GTK+ 3.10 or newer. This is the
+  version that ships starting with Ubuntu 14.04 and Fedora 20. You also need to
+  install the system packages listed in `Tutorial 0 <docs/tutorial/tutorial-0.rst>`__.


Suggested change

* If you're on Unix-like, you need to have GTK+ 3.10 or newer. This is the

version that ships starting with Ubuntu 14.04 and Fedora 20. You also need to

install the system packages listed in `Tutorial 0 <docs/tutorial/tutorial-0.rst>`__.

* If you're on Linux (or another Unix-based operating system), you need to have

GTK+ 3.10 or newer. This is the version that ships starting with Ubuntu 14.04

and Fedora 20. You also need to install the system packages listed in

`Tutorial 0 <docs/tutorial/tutorial-0.rst>`__.```

freakboy3742 · 2023-04-01T00:38:46Z

changes/1836.feature.rst

@@ -0,0 +1 @@
+Add support to FreeBSD OS.


Suggested change

Add support to FreeBSD OS.

Support for FreeBSD was added.

freakboy3742 · 2023-04-01T00:39:43Z

core/src/toga/platform.py

+        if sys.platform.startswith("freebsd"):
+            current_platform = "freeBSD"
+        else:
+            current_platform = _TOGA_PLATFORMS.get(sys.platform)


Suggested change

if sys.platform.startswith("freebsd"):

current_platform = "freeBSD"

else:

current_platform = _TOGA_PLATFORMS.get(sys.platform)

elif sys.platform.startswith("freebsd"):

current_platform = "freeBSD"

else:

current_platform = _TOGA_PLATFORMS.get(sys.platform)

freakboy3742 · 2023-04-01T00:41:16Z

core/src/toga/platform.py

@@ -21,6 +21,7 @@
    "darwin": "macOS",
    "ios": "iOS",
    "linux": "linux",
+    "freebsd": "freeBSD",


This isn't needed if the startswith("freebsd") change is in place. The android version is technically redundant right now, but there's a possibility that we're going to get sys.platform to return android in future, so the line is there for that future possibility.

freakboy3742 · 2023-04-01T00:48:48Z

docs/how-to/contribute-code.rst

@@ -31,7 +31,7 @@ First thing is to ensure that you have Python 3 and pip installed. To do this ru
      $ python3 --version
      $ pip3 --version

-  .. group-tab:: Linux
+  .. group-tab:: Unix-like


...and I'm telling you that I've been working on this project for almost 8 years, and in that entire time, you're the first person who has asked for FreeBSD support. I haven't had any requests for other BSDs (or any other Unix, for that matter).

I hate to break it to you, but non-Linux Unix platforms are niche. FWIW, Linux usage is pretty niche as well - but it's a lot more common than non-Linux Unix, and I'm not convinced that all Linux users actually know that they're running a "Unix-like" operating system. Many do - but you'd be surprised the sorts of questions we get from users.

I'm also not wild about adding a second tab, since the instructions will be exactly the same, so you're adding a maintenance burden to the core team and all other contributors for the benefit of, so far, exactly 1 user.

If FreeBSD users are going to start complaining that the best match for their usage instructions are listed under Linux, not "Unix", then I'm more than willing to offer them a 100% refund of their purchase price.

freakboy3742 · 2023-04-01T00:52:04Z

toga/setup.py

@@ -9,6 +9,7 @@
        # Automatically installed platform backends
        ':sys_platform=="win32"': ["toga-winforms==%s" % version],
        ':sys_platform=="linux"': ["toga-gtk==%s" % version],
+        ':"freebsd" in sys_platform': ["toga-gtk==%s" % version],


Does this actually work? Like - have you tested it? I didn't think the sys_platform syntax was "freeform Python". Can you provide a reference to docs that says this works, and/or another package that does this?

Yes, it works. See this for example.

freakboy3742 · 2023-04-01T00:52:54Z

testbed/pyproject.toml

@@ -63,6 +63,14 @@ flatpak_runtime = "org.gnome.Platform"
 flatpak_runtime_version = "42"
 flatpak_sdk = "org.gnome.Sdk"

+[tool.briefcase.app.testbed.freeBSD]


This won't work until there's a freeBSD backend for Briefcase; and it wouldn't be needed anyway, because it exists to test GTK, not Linux.

freakboy3742 · 2023-04-01T00:55:00Z

docs/how-to/contribute-code.rst


    .. code-block:: bash

+      # Freebsd13
+      (venv) $ sudo pkg update
+      (venv) $ sudo pkg install gtk3 gobject-introspection cairo webkit2-gtk3


I'm not I see sure you your previous comments address 2 and 3. Your other commits introduce compatibility with FreeBSD 12/14, but these docs still explicitly say 13 (point 2); and they're still at the top of the list of Unix options (point 3).

freakboy3742 · 2023-04-01T00:56:42Z

core/setup.cfg

@@ -45,7 +45,9 @@ keywords =
    android
    windows
    winforms
+    unix-like


In case it wasn't clear - these "unix-like" keywords aren't needed. It's not a search term anyone will be looking for.

MuhammadMuradG · 2023-04-01T20:20:19Z

As a side note to the point 4 that you mentioned in your comment, I tested Toga on a clean installation of FreeBSD. FreeBSD comes with all required packages except that I mentioned in the FreeBSD section in the docs or will be installed when these packages are installed.

freakboy3742

I've taken the opportunity to do a couple of unrelated tweaks to the installation instructions; but this all looks good. Thanks for the PR.

MuhammadMouradG added 4 commits March 31, 2023 01:24

Add support to freebsd13

84ed3c4

Add freebsd documentations to docs

0a244b3

Add changenote

68d67aa

Edit README.rst file to match with the changes

2e9d60f

freakboy3742 requested changes Mar 31, 2023

View reviewed changes

MuhammadMouradG added 3 commits March 31, 2023 17:43

Implement the requested changes

ddb31f5

Fix indentation

5fdf8b1

Fix testbed for freebsd

348f1d6

freakboy3742 requested changes Apr 1, 2023

View reviewed changes

MuhammadMouradG added 5 commits April 1, 2023 04:38

Implement the required changes for docs and implementation

f41ad67

Remove unrelevant changes

6d25609

Fix README.rst formating

893e80c

Fix docs typos

fe79dee

Remove unnecessary packages for FreeBSD installation

3b34b4a

Small tweaks to installation guides.

403f9f1

freakboy3742 approved these changes Apr 2, 2023

View reviewed changes

MuhammadMuradG changed the title ~~Freebsd support~~ FreeBSD support Apr 2, 2023

freakboy3742 merged commit 6f4c1e7 into beeware:main Apr 2, 2023

MuhammadMuradG deleted the freebsd_support branch April 2, 2023 01:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FreeBSD support #1836

FreeBSD support #1836

MuhammadMuradG commented Mar 31, 2023

freakboy3742 left a comment

freakboy3742 Mar 31, 2023

MuhammadMuradG Mar 31, 2023

freakboy3742 Mar 31, 2023

MuhammadMuradG Mar 31, 2023

freakboy3742 Mar 31, 2023

MuhammadMuradG Mar 31, 2023

freakboy3742 Mar 31, 2023

MuhammadMuradG Mar 31, 2023 •

edited

Loading

freakboy3742 Apr 1, 2023

freakboy3742 Mar 31, 2023

MuhammadMuradG Mar 31, 2023 •

edited

Loading

freakboy3742 Apr 1, 2023

MuhammadMuradG Apr 1, 2023

freakboy3742 Mar 31, 2023

freakboy3742 Mar 31, 2023

freakboy3742 Mar 31, 2023

freakboy3742 Mar 31, 2023

freakboy3742 Mar 31, 2023

freakboy3742 Apr 1, 2023

freakboy3742 Apr 1, 2023

freakboy3742 Apr 1, 2023

freakboy3742 Apr 1, 2023

freakboy3742 Apr 1, 2023

freakboy3742 Apr 1, 2023

MuhammadMuradG Apr 1, 2023

freakboy3742 Apr 1, 2023

freakboy3742 Apr 1, 2023

freakboy3742 Apr 1, 2023

MuhammadMuradG commented Apr 1, 2023 •

edited

Loading

freakboy3742 left a comment

-* If you're on Unix-like, you need to have GTK+ 3.10 or newer. This is the
-  version that ships starting with Ubuntu 14.04 and Fedora 20. You also need to
-  install the system packages listed in `Tutorial 0 <docs/tutorial/tutorial-0.rst>`__.
+* If you're on Linux (or another Unix-based operating system), you need to have
+  GTK+ 3.10 or newer. This is the version that ships starting with Ubuntu 14.04
+  and Fedora 20. You also need to install the system packages listed in
+  `Tutorial 0 <docs/tutorial/tutorial-0.rst>`__.```

FreeBSD support #1836

FreeBSD support #1836

Conversation

MuhammadMuradG commented Mar 31, 2023

Describe your changes in detail

What problem does this change solve?

PR Checklist:

freakboy3742 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MuhammadMuradG Mar 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MuhammadMuradG Mar 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MuhammadMuradG commented Apr 1, 2023 • edited Loading

freakboy3742 left a comment

Choose a reason for hiding this comment

MuhammadMuradG Mar 31, 2023 •

edited

Loading

MuhammadMuradG Mar 31, 2023 •

edited

Loading

MuhammadMuradG commented Apr 1, 2023 •

edited

Loading