Skip to content

Latest commit

 

History

History
147 lines (112 loc) · 5.18 KB

README.md

File metadata and controls

147 lines (112 loc) · 5.18 KB
Raw

pySavitar

This library contains the Python bindings for loading 3mf files using Savitar.

License

License
pySavitar is released under terms of the LGPLv3 License. Terms of the license can be found in the LICENSE file. Or at http://www.gnu.org/licenses/lgpl.html

But in general it boils down to:
You need to share the source of any pySavitar modifications if you make an application with pySavitar.

System Requirements

Windows

  • Python 3.6 or higher
  • Ninja 1.10 or higher
  • VS2022 or higher
  • CMake 3.23 or higher
  • nmake
  • sip 6.5.0 or higher
  • Conan 1.56.0

MacOs

  • Python 3.6 or higher
  • Ninja 1.10 or higher
  • apply clang 11 or higher
  • CMake 3.23 or higher
  • make
  • sip 6.5.0 or higher
  • Conan 1.56.0

Linux

  • Python 3.6 or higher
  • Ninja 1.10 or higher
  • gcc 12 or higher
  • CMake 3.23 or higher
  • make
  • sip 6.5.0 or higher
  • Conan 1.56.0

How To Build

Note:
We are currently in the process of switch our builds and pipelines to an approach which uses Conan and pip to manage our dependencies, which are stored on our JFrog Artifactory server and in the pypi.org. At the moment not everything is fully ported yet, so bare with us.

If you want to develop Cura with pySavitar see the Cura Wiki: Running Cura from source

If you have never used Conan read their documentation which is quite extensive and well maintained. Conan is a Python program and can be installed using pip

1. Configure Conan

pip install conan==1.56
conan config install https://github.com/ultimaker/conan-config.git
conan profile new default --detect --force

Community developers would have to remove the Conan cura repository because it requires credentials,

Ultimaker developers need to request an account for our JFrog Artifactory server at IT

conan remote remove cura

2. Clone pySavitar

git clone https://github.com/Ultimaker/pySavitar.git
cd pySavitar

3. Install & Build pySavitar (Release OR Debug)

Release

conan install . --build=missing --update
# optional for a specific version: conan install . pysavitar/<version>@<user>/<channel> --build=missing --update
conan build .
# or
sip-install

Debug

conan install . --build=missing --update build_type=Debug
conan build .
# or
sip-install

Creating a new pySavitar Conan package

To create a new pySavitar Conan package such that it can be used in Cura and Uranium, run the following command:

conan create . pysavitar/<version>@<username>/<channel> --build=missing --update

This package will be stored in the local Conan cache (~/.conan/data or C:\Users\username\.conan\data ) and can be used in downstream projects, such as Cura and Uranium by adding it as a requirement in the conanfile.py or in conandata.yml.

Note: Make sure that the used <version> is present in the conandata.yml in the pySavitar root

You can also specify the override at the commandline, to use the newly created package, when you execute the conan install command in the root of the consuming project, with:

conan install . -build=missing --update --require-override=pysavitar/<version>@<username>/<channel>

Developing pySavitar In Editable Mode

You can use your local development repository downsteam by adding it as an editable mode package. This means you can test this in a consuming project without creating a new package for this project every time.

    conan editable add . pysavitar/<version>@<username>/<channel>

Then in your downsteam projects (Cura) root directory override the package with your editable mode package.

conan install . -build=missing --update --require-override=pysavitar/<version>@<username>/<channel>