The following sections are meant as contributing guidelines, or best-practices. We encourage you to follow them, but your contribution may still be accepted without following them strictly.
Are you a potential first-time contributor? Look for issues tagged with good first issue.
- Install conda
- Install conda-build
Create osewb conda environment with freecad:
conda create --name osewb --channel conda-forge --yes freecad==0.19.alpha2
Activate osewb environment:
conda activate osewb
Install ose-workbench-platform:
pip install --editable .
Add the $CONDA_PREFIX/lib directory to $PYTHONPATH by running:
./post-link.sh
Note: This allows FreeCAD to be imported as a module within python.
Deactivate and re-activate osewb environment:
conda deactivate && conda activate osewb
Verify everything works:
osewb test
Code should follow the official PEP 8 -- Style Guide for Python Code.
We generally subscribe to the philosophy provided by The Zen of Python.
>>> import this;
The Zen of Python, by Tim Peters
Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!
A release.bash convenience script has been included in the root of the repository to make cutting releases easier.
Currently, only G Roques, the maintainer, has credentials to deploy the a release to PyPi and Anaconda Cloud.