mirrors/build123d
1
Fork 0
mirror of https://github.com/gumyr/build123d.git synced 2025-12-06 02:30:55 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updating docs for pypi installation

Browse source
This commit is contained in:
gumyr 2023-12-06 14:43:41 -05:00
parent 671db72857
commit 2aa2908933
2 changed files with 37 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -15,7 +15,12 @@ The documentation for **build123d** can found at [readthedocs](https://build123d
There is a [***Discord***](https://discord.com/invite/Bj9AQPsCfx) server (shared with CadQuery) where you can ask for help in the build123d channel.
The recommended method for most users is to install **build123d** with one of the following two commands.
The recommended method for most users is to install **build123d** is:
```
pip install build123d
```
To get the latest non-released version of **build123d*** one can install from GitHub using one of the following two commands:
In Linux/MacOS, use the following command:
```
@ -25,6 +30,7 @@ In Windows, use the following command:
```
python -m pip install git+https://github.com/gumyr/build123d
```
If you receive errors about conflicting dependencies, you can retry the installation after having upgraded pip to the latest version with the following command:
```
python3 -m pip install --upgrade pip

35
docs/installation.rst
View file

@ -1,10 +1,22 @@
############
Installation
############
Install build123d from github:
----------------------------------------------
The recommended method for most users is to install build123d with one of the following two commands.
The recommended method for most users is to install **build123d** is:
.. doctest::
>>> pip install build123d
.. note::
The `ocp-vscode <https://github.com/bernhard-42/vscode-ocp-cad-viewer>`_ viewer has
the ability to install **build123d**.
Install build123d from GitHub:
------------------------------
To get the latest non-released version of **build123d** one can install from GitHub using one of the following two commands:
In Linux/MacOS, use the following command:
@ -25,8 +37,14 @@ upgraded pip to the latest version with the following command:
>>> python3 -m pip install --upgrade pip
If you use `poetry <https://python-poetry.org/>`_ to install build123d, you might need to specify
the branch that is used for git-based installs ; until quite recently, poetry used to checkout the
If you use `poetry <https://python-poetry.org/>`_ to install build123d, you can simply use:
.. doctest::
>>> poetry add build123d
However, if you want the latest commit from GitHub you might need to specify
the branch that is used for git-based installs; until quite recently, poetry used to checkout the
`master` branch when none was specified, and this fails on build123d that uses a `dev` branch.
Pip does not suffer from this issue because it correctly fetches the repository default branch.
@ -62,6 +80,13 @@ with the following commands:
Please substitute ``python3`` with ``python`` in the lines above if you are using Windows.
If you're working directly with the OpenCascade ``OCP`` layer you will likely want to install
the OCP stubs as follows:
.. doctest::
>>> python3 -m pip install git+https://github.com/CadQuery/OCP-stubs@7.7.0
Test your build123d installation:
----------------------------------------------
If all has gone well, you can open a command line/prompt, and type: