third_party.pigweed.src/pw_build/python_dist/README.md
Joe Ethier fbe661502f pw_build: Add tools for creating py distributables
Change-Id: Ifac2ad9f647f416b3aef5812a08187a8313d65ed
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/39664
Commit-Queue: Joe Ethier <jethier@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
Reviewed-by: Wyatt Hepler <hepler@google.com>
2021-05-07 17:21:54 +00:00

34 lines
605 B
Markdown

# Python Distributables
Setup and usage instructions for Pigweed Python distributables.
## Prerequisites
Python distributables require Python 3.7 or later.
## Setup
Run the included setup script found inside the unzipped directory.
Linux / MacOS:
```bash
setup.sh
```
Windows:
```
setup.bat
```
The setup script will create a virtual environment called `python-venv`.
### Usage
Once setup is complete, the Python tools can be invoked as runnable modules:
Linux/MacOS:
```bash
python-venv/bin/python -m MODULE_NAME [OPTIONS]
```
Windows:
```
python-venv\Scripts\python -m MODULE_NAME [OPTIONS]
```