Skip to content

Application

General metadata about the application being built.

Name

The name of the application being built.

project.application.name = "Pyaket"

pyaket app --name "Pyaket" (...)

[application]
name = "Pyaket"

Author

The author's name, group, organization of the application being built.

project.application.author = "BrokenSource"

pyaket app --author "BrokenSource" (...)

[application]
author = "BrokenSource"

Vendor

Always equal to Author if set, otherwise Name.

This value primarily determines the Workspace Root location when dynamic.

Using an empty Author is a way to isolate each project virtual environment.

  • While not recommended due spamming the user data dir, it works for single banner-less projects. For that, set the python field to None or unset it entirely.

Overriding:

project.application.vendor = "Tremeschin"

pyaket app --vendor "Tremeschin" (...)

[application]
vendor = "Tremeschin"

Version

The version of the application being built.

Should follow the same number of the project to be released alonside a registry. Not necessarily a semantic version, can be a codename, branch name, "latest", etc.

project.application.version = "1.2.3"

pyaket app --version "1.2.3" (...)

[application]
version = "1.2.3"

The value is appended to the Versions Directory to build the virtual environment path.

Projects with the same version and subdirectories shares the same venv!

  • First-class monorepo support with a global versioning scheme.

About

A description of the application, exclusively for metadata or banner purposes.

project.application.about = "No description provided"

pyaket app --about "No description provided" (...)

[application]
about = "No description provided"

Icon

Stub: Not implemented

An image path to use as the application icon.

# Can be Path, str, Image, numpy.
project.application.icon = Path

pyaket app --icon "path/to/icon.png" (...)

[application]
icon = "path/to/icon.png"


Platform support:

Supported via Desktop Entries XDG Specification.

  • Run ./project self desktop to generate one at ~/.local/share/applications/$project.{desktop,png}

Wayland does not support icons outside .desktop files

Natively supported and implemented via crates.io/winresource

  • Icon should appear in File Explorer and Task bar.

Not implemented, but seems to be possible.

  • Consider supporting my work or sending Apple hardware for development!