Overall guidance on contributing to a PyAnsys library appears in the Contributing topic in the PyAnsys Developer's Guide. Ensure that you are thoroughly familiar with it and all Guidelines and Best Practices before attempting to contribute to PyScadeOne.
The following contribution information is specific to PyScadeOne.
Run this code to clone and install the latest version of PyScadeOne in development mode:
git clone https://github.com/pyansys/pyscadeone cd pyscadeone pip install pip -U pip install -e .
Use the PyScadeOne Issues page to submit questions, report bugs, and request new features. When possible, we recommend that you use these issue templates:
- Bug report template
- Feature request template
If your issue does not fit into one of these categories, create your own issue.
To reach the project support team, email pyansys.support@ansys.com.
Documentation for the latest stable release of PyScadeOne is hosted at PyScadeOne Documentation.
Documentation for the latest development version, which tracks the
main branch, is hosted at Development PyScadeOne Documentation.
This version is automatically kept up to date via GitHub actions.
PyScadeOne uses pytest. In the main directory use:
pytest
Tests are in tests folder. Please add your own tests for non-regression.
PyScadeOne follows PEP8 standard as outlined in the PyAnsys Development Guide and implements style checking using pre-commit.
To ensure your code meets minimum code styling standards, run:
pip install pre-commit pre-commit run --all-files
You can also install this as a pre-commit hook by running:
pre-commit install
This way, it's not possible for you to push code that fails the style checks. For example:
$ pre-commit install $ git commit -am "added my cool feature" black....................................................................Passed isort....................................................................Passed flake8...................................................................Passed codespell................................................................Passed
PyScadeOne has a logging tool and a log file that is automatically generated in the project folder.
The logging tool is a attached to a ScadeOne instance, and the instance is passed to projects, project is passed to models, etc.
app = ScadeOne()
app.logger.error("This is an error message.")
app.logger.warning("This is a warning message.")
app.logger.info("This is an info message.")Best practice is to keep the length at or below 120 characters for code, docstrings, and comments. Lines longer than this might not display properly on some terminals and tools or might be difficult to follow.