Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

This is the Zephyr RTOS meta tool, west.

https://docs.zephyrproject.org/latest/guides/west/index.html

Installation

Using pip:

pip3 install west

(Use pip3 uninstall west to uninstall it.)

Basic Usage

West lets you manage multiple Git repositories under a single directory using a single file, called the west manifest file, or manifest for short. By default the manifest file is named west.yml. You use west init to set up this directory, then west update to fetch and/or update the repositories named in the manifest.

By default, west uses upstream Zephyr’s manifest file, but west doesn’t care if the manifest repository is a Zephyr tree or not.

For more details, see Multiple Repository Management in the west documentation.

Example usage using the upstream manifest file:

mkdir zephyrproject && cd zephyrproject
west init
west update

What just happened:

  • west init clones the upstream west manifest repository, which in this case is the zephyr repository. The manifest repository contains west.yml, a YAML description of the Zephyr installation, including Git repositories and other metadata.

  • west update clones the other repositories named in the manifest file, creating working trees in the installation directory zephyrproject.

Use west init -m to specify another manifest repository. Use --mr to use a revision to inialize from; if not given, the remote’s default branch is used. Use --mf to use a manifest file other than west.yml.

Additional Commands

West has multiple sub-commands. After running west init, you can run them from anywhere under zephyrproject.

For a list of available commands, run west -h. Get help on a command with west <command> -h.

West is extensible: you can add new commands to west without modifying its source code. See Extensions in the documentation for details.

Running the Tests

First, install tox:

# macOS, Windows
pip3 install tox

# Linux
pip3 install --user tox

Then, run the test suite locally from the top level directory:

tox

See the tox configuration file, tox.ini, for more details.

Hacking on West

Installing from Source

The wheel package is required to install west from source. See “Installing Wheel” below if you don’t have wheel installed.

To build the west wheel file:

# macOS, Linux
python3 setup.py bdist_wheel

# Windows
py -3 setup.py bdist_wheel

This will create a file named dist/west-x.y.z-py3-none-any.whl, where x.y.z is the current version in setup.py.

To install the wheel:

pip3 install -U dist/west-x.y.z-py3-none-any.whl

You can pip3 uninstall west to remove this wheel before re-installing the version from PyPI, etc.

Editable Install

To run west “live” from the current source code tree, run this command from the top level directory in the west repository:

pip3 install -e .

This is useful if you are actively working on west and don’t want to re-package and install a wheel each time you run it.

Installing Wheel

On macOS and Windows, you can install wheel with:

pip3 install wheel

That also works on Linux, but you may want to install wheel from your system package manager instead – e.g. if you installed pip from your system package manager. The wheel package is likely named something like python3-wheel in that case.

Metadata

Release files for west 0.12.0a2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for west 0.12.0a2
File Size Uploaded Provenance Actions
west-0.12.0a2.tar.gz 77.0 kB Without provenance Details for west-0.12.0a2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for west 0.12.0a2
File Interpreter ABI Platform Actions
west-0.12.0a2-py3-none-any.whl Python 3 none any Details for west-0.12.0a2-py3-none-any.whl

Total release size: 162.7 kB

Release files / west-0.12.0a2.tar.gz

Download URL west-0.12.0a2.tar.gz
Size 77.0 kB
Tags Source
SHA-256 checksum
How to use checksums
79ddc959983650c00b29def7edfe6381da7ad0d0911f4598c680f2c41a1e254c
BLAKE2b-256 checksum
How to use checksums
d57af003c51c1c3e7ebde91235d5b8c9bef3ab3d09993ebbc9e97e0b299ebb4f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

Release files / west-0.12.0a2-py3-none-any.whl

Download URL west-0.12.0a2-py3-none-any.whl
Size 85.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
85af51921c30a31483f174b5135c514e49cfa665dbdec425bc1fe9020c3293c5
BLAKE2b-256 checksum
How to use checksums
651c88add23e6f21feb5d61be26b005ad7524f1f0edd75983a4d2de05d4dabd5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

Security for west 0.12.0a2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page