mirror of
https://github.com/gumyr/build123d.git
synced 2025-12-15 15:20:37 -08:00
13 lines
834 B
Markdown
13 lines
834 B
Markdown
When writing code for inclusion in build123d please add docs and
|
|
tests, ensure they build and pass, and ensure that `pylint` and `mypy`
|
|
are happy with your code.
|
|
|
|
- Install `pip` following their [documentation](https://pip.pypa.io/en/stable/installation/).
|
|
- Install development dependencies: `pip install -e ".[development]"`
|
|
- Install docs dependencies: `pip install -e ".[docs]"`
|
|
- Install `build123d` in editable mode from current dir: `pip install -e .`
|
|
- Run tests with: `python -m pytest -n auto`
|
|
- Build docs with: `cd docs && make html`
|
|
- Check added files' style with: `pylint <path/to/file.py>`
|
|
- Check added files' type annotations with: `mypy <path/to/file.py>`
|
|
- Run black formatter against files' changed: `black --config pyproject.toml <path/to/file.py>` (where the pyproject.toml is from this project's repository)
|