[mirror_edk2.git] / BaseTools / Source / Python / README.md

# Edk2 Basetools\r
\r
This folder has traditionally held the source of Python based tools used by EDK2.\r
The official repo this source has moved to https://github.com/tianocore/edk2-basetools.\r
This folder will remain in the tree until the next stable release (expected 202102).\r
There is a new folder under Basetools `BinPipWrappers` that uses the pip module rather than this tree for Basetools.\r
By adding the scope `pipbuild-win` or `pipbuild-unix` (depending on your host system), the SDE will use the\r
`BinPipWrappers` instead of the regular `BinWrappers`.\r
\r
## Why Move It?\r
\r
The discussion is on the mailing list. The RFC is here: https://edk2.groups.io/g/rfc/topic/74009714#270\r
The benefits allow for the Basetools project to be used separately from EDK2 itself as well as offering it in a\r
globally accessible manner.\r
This makes it much easier to build a module using Basetools.\r
Separating the Basetools into their own repo allows for easier CI and contribution process.\r
Additional pros, cons, and process can be found on the mailing list.\r
\r
## How Do I Install It?\r
\r
By default, EDK2 is tied to and tested with a specific version of the Basetools through `pip-requirements.txt`.\r
You can simply run:\r
\r
```bash\r
pip install -r pip-requirements.txt\r
```\r
\r
This will install the required module, thought we strongly suggest setting up a virtual environment.\r
Additionally, you can also install a local clone of the Basetools as well as a specific git commit.\r
Commit	Line	Data
1534b622 MC	1	# Edk2 Basetools\r
	2	\r
	3	This folder has traditionally held the source of Python based tools used by EDK2.\r
	4	The official repo this source has moved to https://github.com/tianocore/edk2-basetools.\r
	5	This folder will remain in the tree until the next stable release (expected 202102).\r
	6	There is a new folder under Basetools `BinPipWrappers` that uses the pip module rather than this tree for Basetools.\r
	7	By adding the scope `pipbuild-win` or `pipbuild-unix` (depending on your host system), the SDE will use the\r
	8	`BinPipWrappers` instead of the regular `BinWrappers`.\r
	9	\r
	10	## Why Move It?\r
	11	\r
	12	The discussion is on the mailing list. The RFC is here: https://edk2.groups.io/g/rfc/topic/74009714#270\r
	13	The benefits allow for the Basetools project to be used separately from EDK2 itself as well as offering it in a\r
	14	globally accessible manner.\r
	15	This makes it much easier to build a module using Basetools.\r
	16	Separating the Basetools into their own repo allows for easier CI and contribution process.\r
	17	Additional pros, cons, and process can be found on the mailing list.\r
	18	\r
	19	## How Do I Install It?\r
	20	\r
	21	By default, EDK2 is tied to and tested with a specific version of the Basetools through `pip-requirements.txt`.\r
	22	You can simply run:\r
	23	\r
	24	```bash\r
	25	pip install -r pip-requirements.txt\r
	26	```\r
	27	\r
	28	This will install the required module, thought we strongly suggest setting up a virtual environment.\r
	29	Additionally, you can also install a local clone of the Basetools as well as a specific git commit.\r