MaixPy develop source code guide
Get source code
git clone https://github.com/sipeed/MaixPy
cd MaixPy
Build and pack to wheel
python setup.py bdist_wheel maixcam
maixcam
Can be replaced with other board config, see setup.py 's platform_names
variable.
After build success, you will find wheel file in dist
directory, use pip install -U MaixPy****.wheel
on your device to install or upgrade.
python setup.py bdist_wheel maixcam --skip-build
will not execute build command and only pack wheel, so you can usemaixcdk menuconfig
andmaixcdk build
first to customize building.
Build manually
maixcdk build
Run test after modify source code
- First, build source code by
maixcdk build
- If build for PC self(platform
linux
):
Then execute ./run.sh your_test_file_name.py
to run python script.
cd test
./run.sh examples/hello_maix.py
- If cross compile for borad:
- The fastest way is copy
maix
dir to device's/usr/lib/python3.11/site-packages/
directory, then run script on device. - Or pack wheel and install on device by
pip install -U MaixPy****.wheel
, then run script on device.
- The fastest way is copy
Preview documentation locally
Documentation in docs directory, use Markdown
format, you can use teedoc to generate web version documentation.
And the API doc is generated when build MaixPy firmware, if you don't build MaixPy, the API doc will be empty.
pip install teedoc -U
cd docs
teedoc install -i https://pypi.tuna.tsinghua.edu.cn/simple
teedoc serve
Then visit http://127.0.0.1:2333
to preview documentation on web browser.
For developers who want to contribute
See MaixPy develop source code guide
If you encounter any problems when use source code, please refer to FAQ first.