Metadata-Version: 2.1
Name: zup
Version: 0.1.6
Summary: Zig compiler multiplexer
Home-page: https://github.com/yamirui/zup
Author: yamirui
Author-email: yamirui.git@gmail.com
License: zlib
Keywords: zig
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: zlib/libpng License
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Installation/Setup
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# zup

### dependencies
* Python 3.8

### Installation
```bash
$ pip install zup
```

### Installing Zig

This will install latest master Zig release and set it as default `zig` command in your system.

Note that zup never modifies your system configuration and you must add the symlink directory that zup manages to your `%PATH%` on Windows or `$PATH` on other platforms.
```bash
zup install master -d
```

### Configuration
Config file is a python script that gets executed before any command is ran.
It can be opened with `zup config`. This uses your default program for a filetype; on windows the default is `python.exe`, please set it to a proper text editor or it won't open. Zup does not check or configure any system variables and can't know what the config will be opened with and it is your job as the owner of your system to configure it properly.
```python
# config.py
# windows: Path(os.getenv('APPDATA')) / 'zup/config.py'
# macos: Path.home() / 'Library/Preferences/zup/config.py'
# other: Path.home() / '.config/zup/config.py'

# url where index will be fetched from
# default: 'https://ziglang.org/download/index.json'
index_url = zup.config.default_index_url()

# directory where zig compilers are installed
# windows: Path(os.getenv('LOCALAPPDATA')) / 'zup'
# macos: Path.home() / 'Library/Application Support/zup'
# other: Path.home() / '.local/share/zup'
install_dir = zup.config.default_install_dir()

# directory where symlinks to compilers are created
# windows: install_dir
# macos: install_dir
# other: Path.home() / '.local/bin'
symlink_dir = zup.config.default_symlink_dir()
```




