Development

There is a mailing group to receive your inputs and questions: MotorControl@microchip.com

Contribution

Contribute to source code, documentation, examples and report issues: https://github.com/X2Cscope/pyx2cscope

Fork the pyX2Cscope repository.
Create a new branch for your changes.
Make the necessary changes and commit them.
Push your changes to your forked repository.
Open a pull request on the main pyX2Cscope repository, describing your changes.

We appreciate your contribution!

Set-up the dev system

Create virtual envrionment with make venv

git clone https://github.com/X2Cscope/pyx2cscope.git
cd pyx2cscope
python -m venv .venv
#Windows
.venv\Scripts\activate
#linux
source .venv\bin\activate

Installing dev requirements

pip install -r requirements.txt
pip install -r quality.txt

Running tests

ruff syntax check

ruff check .

pytest

pytest

Building docs

sphinx-build -M html doc build --keep-going  

Creating executables

pyinstaller --noconfirm .\pyx2cscope_win.spec 