ybox 0.9.8__py3-none-any.whl → 0.9.8.1__py3-none-any.whl

ybox/__init__.py

@@ -1,2 +1,2 @@
 """`ybox` is a tool to easily manage linux distributions in containers"""
-__version__ = "0.9.8"
+__version__ = "0.9.8.1"

{ybox-0.9.8.dist-info → ybox-0.9.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ybox
-Version: 0.9.8
+Version: 0.9.8.1
 Summary: Securely run Linux distribution inside a container
 Author-email: Sumedh Wale <sumwale@yahoo.com>, Vishal Rao <vishalrao@gmail.com>
 License: Copyright (c) 2024-2025 Sumedh Wale and contributors
@@ -101,7 +101,7 @@ you can simply launch it from your desktop environment's applications as usual.
 
 In this way this acts as a complete replacement of flatpak/snap while being able to choose
 from way bigger software repositories, and with applications configured the way they are
-supposed to be in the original Linux distribution (which is only Arch Linux for now).
+supposed to be in the original Linux distribution.
 The big difference being that these are just containers where you can open a shell
 (using `ybox-cmd`) and learn/play as required, or micro-configure stuff. The shell will
 behave quite like a full Linux installation apart from missing system-level stuff like systemd.
@@ -109,37 +109,50 @@ behave quite like a full Linux installation apart from missing system-level stuf
 
 ## Installation
 
-If you have cloned the repository, then no further installation is required to run the utilities
-in `src` directory which can be done directly off the repository. In the near future this will
-also be published on `pypi.org`, so you will be able to install with `pip install --user ybox`.
-
-As of now the following is required:
-
-- clone the repo: `git clone https://github.com/sumwale/ybox.git`
-- rootless podman or docker
-  * for podman this needs installation of `podman` and `slirp4netns`/`passt` packages,
-    then setup /etc/subuid and /etc/subgid as noted here:
-    [/etc/subuid and /etc/subgid configuration](https://github.com/containers/podman/blob/main/docs/tutorials/rootless_tutorial.md#etcsubuid-and-etcsubgid-configuration)
-    (many distributions like ubuntu will set up subuid/subgid for current user automatically)
-  * for docker follow the instructions in the official [docs](https://docs.docker.com/engine/security/rootless/)
-- python version 3.9 or higher -- all fairly recent Linux distributions should satisfy this
-  but still confirm with `python3 --version`
-- install [simple-term-menu](https://pypi.org/project/simple-term-menu/),
-  [tabulate](https://pypi.org/project/tabulate/) and
-  [packaging](https://pypi.org/project/packaging/),  either from your distribution
-  repository, if available, else: `pip install --user simple-term-menu packaging tabulate`
-  (obviously you will need `pip` itself to be installed which should be in your
-   distribution repositories e.g. ubuntu/debian have it as `python3-pip`)
-
-In the future, installer will take care of setting all of these up.
-
-Now you can simply go to the repository and run the `ybox-create` and other utilities from
-the `src` directory of the repository checkout. For convenience, you can symlink these to
-your `~/.local/bin` directory which should be in PATH in modern Linux distributions:
-
-```sh
-ln -s <full path of checkout ybox directory>/src/ybox-* ~/.local/bin/
-```
+First install the requirements:
+
+- Python version 3.9 or higher. All recent Linux distributions should satisfy
+  this but still confirm with `python3 --version`.
+- Rootless podman or docker. Podman is recommended as it works out of the box for most
+        distributions and container runs as normal non-root user unlike docker that
+        needs to run as root in the container that may break some applications.
+  * For podman this needs installation of `podman` and `slirp4netns` (or `passt` with
+          podman >= 5) packages. Then setup /etc/subuid and /etc/subgid as noted here:
+    [/etc/subuid and /etc/subgid configuration](https://github.com/containers/podman/blob/main/docs/tutorials/rootless_tutorial.md#etcsubuid-and-etcsubgid-configuration).
+    Most distributions will set up subuid/subgid for current user automatically
+    and rootless podman works out of the box after installation (tested on Ubuntu,
+            Arch and Debian). Check with `podman unshare cat /proc/self/uid_map` which
+    should show an output like:
+    ```
+         0       1000          1
+         1     100000      65536
+    ```
+    where `1000` is the current user's ID (output of `id -u`).
+  * For docker follow the instructions in the official [docs](https://docs.docker.com/engine/security/rootless/).
+
+Finally install the `ybox` package for the current user using `pip` (`pip` is installed
+    on most Linux distributions by default, or install from your distribution's
+    repository e.g. `python3-pip` for Debian/Ubuntu based distros, `python-pip` on Arch):
+
+```sh
+pip install ybox --user
+```
+
+Note that newer versions of `pip` disallow installing packages directly and instead
+require you to install in a custom virtual environment which can be done manually
+(e.g. bash/zsh: `python3 -m venv ybox-venv && source ybox-env/bin/activate`,
+ fish: `python3 -m venv ybox-venv && source ybox-env/bin/activate.fish`)
+or automatically using `pipx`. Alternatively you can add `--break-system-packages`
+flag to the `pip` command above or add it globally for all future packages using
+`python3 -m pip config set global.break-system-packages true`. The alternative
+approach works well for `ybox` which has a very minimal set of dependencies but
+in the rare case you see any issues due to package conflicts, use `pipx` or
+manual virtual environment.
+
+Now you can run the `ybox-create` and other utilities that are normally installed
+in your `~/.local/bin` directory which should be in PATH for modern Linux distributions.
+If not, then add it to your PATH in your `.bashrc` (for bash) or the configuration
+file of your login shell.
 
 All the `ybox-*` utilities will show detailed help with the `-h`/`--help` option.
 
@@ -182,7 +195,7 @@ e.g. `~/.local/share/ybox/ybox-arch_apps/home` for the above example.
 
 When shared root directory is enabled (which is the default in the shipped profiles), then
 it uses the common distribution path in `~/.local/share/ybox/SHARED_ROOTS/<distribution>`
-by default i.e. `~/.local/share/ybox/SHARED_ROOTS/arch` for the Arch Linux guests.
+by default e.g. `~/.local/share/ybox/SHARED_ROOTS/arch` for the Arch Linux guests.
 
 For more advanced usage, you can copy from the available profiles in `src/ybox/conf/profiles`
 into `~/.config/ybox/profiles`, then edit as required. The `basic.ini` profile lists

{ybox-0.9.8.dist-info → ybox-0.9.8.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-ybox/__init__.py,sha256=8FzWRJgA6Vf9G715kHHM9hIALv9DUhgcadJtma5PKvc,96
+ybox/__init__.py,sha256=kl9lbkmRtTLHzBTo46cujYUSW33NWkFAXy2YJ9KXVzQ,98
 ybox/cmd.py,sha256=49a1Oo1YgLbXlHqZ1PL1okKGtxlXya1DClM-uh1TuKI,14213
 ybox/config.py,sha256=bFz6MIVCEbwOjG0m6L5JPngQqta5J9aXU4osKtD2QDE,9632
 ybox/env.py,sha256=vfHuvTOpApR4fLx1vePWRrTYxzo50c-7dFcnm1-vDHo,8738
@@ -68,9 +68,9 @@ ybox/schema/migrate/0.9.0:0.9.1.sql,sha256=e9JGwrjFZXdWKGv2JQZlKcWz8DmOuUARpToSs
 ybox/schema/migrate/0.9.1:0.9.2.sql,sha256=X5J3unDS0eLeVvYKxQgx-iUBoAOk9T2suO34pWlQ-lE,362
 ybox/schema/migrate/0.9.2:0.9.3.sql,sha256=Y7GeBSuEEs7Hs9hh-KYDARgeeMgwQwercvTB5P_-k6I,102
 ybox/schema/migrate/0.9.5:0.9.6.sql,sha256=wqYhmputlUQzBI5zfP7O5kqIFWAbZQ05kolyHK4714A,70
-ybox-0.9.8.dist-info/LICENSE,sha256=7GbFgERMXSwD1VyLA5bo_XHvJipmNEUhDW5Sy51TFeY,1077
-ybox-0.9.8.dist-info/METADATA,sha256=voBq82-8y-GKD1wzYEdXPwTniZlcWDyHVAl3vj8isAg,23050
-ybox-0.9.8.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ybox-0.9.8.dist-info/entry_points.txt,sha256=xDlI_84Hl3ytYO_ERyt0rkJ4ioUF8Z1r49Hx1xL28Rk,243
-ybox-0.9.8.dist-info/top_level.txt,sha256=DYX7jvndHcBaJXLJ8vDyKrq0_KWoSeXXFq8r0d5L6Nk,5
-ybox-0.9.8.dist-info/RECORD,,
+ybox-0.9.8.1.dist-info/LICENSE,sha256=7GbFgERMXSwD1VyLA5bo_XHvJipmNEUhDW5Sy51TFeY,1077
+ybox-0.9.8.1.dist-info/METADATA,sha256=spbTqpj_dPdL2S9_17cmeiPcDuvFTY0mGzq0XMYvRcw,23682
+ybox-0.9.8.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+ybox-0.9.8.1.dist-info/entry_points.txt,sha256=xDlI_84Hl3ytYO_ERyt0rkJ4ioUF8Z1r49Hx1xL28Rk,243
+ybox-0.9.8.1.dist-info/top_level.txt,sha256=DYX7jvndHcBaJXLJ8vDyKrq0_KWoSeXXFq8r0d5L6Nk,5
+ybox-0.9.8.1.dist-info/RECORD,,