Directories
Directories¶
Directories used by Pyaket to store the application data.
WORKSPACE¶
📦 Type: Path • Default: Dynamic
The workspace root directory Pyaket will use for the project.
This is a special variable that can be overriden at runtime and is dynamic if unset. By default, Pyaket uses proper and intended platform directories to store the application data:
| Windows | C:\Users\User\AppData\Local\Author |
| MacOS | ~/Library/Application Support/Author |
| Linux | ~/.share/Author |
Shall a user set it, the value is used as is. This is especially useful if folks have a full C:\ drive or want a custom directory than the above for large application data. A Python project should follow the same pattern, so all files are in the same place for easier uninstallation.
PYAKET_COMMON_DIR¶
📦 Type: Path • Default: Pyaket
The subdirectory of the workspace to use for all Pyaket installation and runtime files.
By default, things are stored in a Pyaket directory (due lack of a better name). All other internal directories derives from this one. It can be left empty if you'll not use platformdirs yourself.
| Windows | C:\Users\User\AppData\Local\Author\Pyaket |
| MacOS | ~/Library/Application Support/Author/Pyaket |
| Linux | ~/.share/Author/Pyaket |
| Custom | Workspace/Pyaket |
You may find the following directories inside the composition:
- Astral: Stores uv versions, archives and unpacked files.
- Cache: Used for
UV_CACHE_DIR, primarily package download caches. - Python: Stores multiple versions of Python distributions.
- Versions: See versions dir for more details.
PYAKET_VERSIONS_DIR¶
📦 Type: String • Default: Versions
The subdirectory of the common directory to install the virtual environments.
Multiple versions of the same application(s) are stored in a shared directory (venv). From the table below, (...) is replaced with the version, yielding the full installation path.
| Windows | C:\Users\User\AppData\Local\Author\Pyaket\Versions\(...) |
| MacOS | ~/Library/Application Support/Author/Pyaket/Versions/(...) |
| Linux | ~/.share/Author/Pyaket/Versions/(...) |
| Custom | Workspace/Pyaket/Versions/(...) |
- Note: Applications of an author that shares the same versions dir must be coupled together. If they are independent, a workaround is to set this value to
Versions/<app_name>, so each application have a separate versions directory. Default is shared for monorepos in mind.