diff --git a/Readme.md b/Readme.md index 95b87bd57311d4cae798a1aaccf91441f8f27706..aed0f8c93934dc8c4380112b1760cbd1621dfe2f 100644 --- a/Readme.md +++ b/Readme.md @@ -1,24 +1,23 @@ # FBXSDK Python Bindings The Source Distribution (sdist) repository for the FBXSDK Python Bindings -**Packages for the Source Distribution and wheels (prebuilt binaries) can be installed with pip (see Install)** +**A source packages can be built and installed with pip (see Install)** ## Install -1. Obtain a [Gitlab Token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token) to authenticate to the project pypi repository -2. Run the following command, with `<Gitlab Token>` replaced with your personal token : ``` -pip --verbose install fbxsdkpy --extra-index-url https://__token__:<Gitlab Token>@gitlab.inria.fr/api/v4/projects/18034/packages/pypi/simple +pip --verbose install fbxsdkpy --extra-index-url https://gitlab.inria.fr/api/v4/projects/18692/packages/pypi/simple ``` -If there is no wheel available for your platform, pip will attempt to build from source -To force an install from source, pass the `--no-binary fbxsdkpy` option to pip +This will download the sources from Autodesk website, build them, and install the built package ## Manual Build Alternatively, the bindings can be built and installed by cloning this repository and running `pip --verbose install .` -### Remarks +## Troubleshooting -- Instead of the libraries and bindings from Autodesk being included in the repository, they are downloaded before building -- `--verbose` is recommended to get the output of the compiler in case of an error. Also, as compilation can take several minutes, `pip` might otherwise seem unresponsive +- `--verbose` is recommended to get the output of the compiler in case of an error. Also, as compilation can take several minutes, `pip` might otherwise seem unresponsive +- On outdated Windows versions, curl is not available, in this case install it from [https://curl.se/](https://curl.se/) +- On Windows, Build Tools are required for compiling, and C++ Redistributables for runtime, they are available individually on Microsoft's website, or with Visual Studio - On Windows, the installers from Autodesk trigger Permission Requests, if left unanswered they will timeout, the installation will continue without the required files and quietly fail. A solution to run the installation unattended is to do it from an Administrator command line +- For more on runtime errors, see [PyNimation documentation](https://lhoyet.gitlabpages.inria.fr/pynimation/static/overview/troubleshooting.html#importerror-dll-load-failed-while-importing-fbx)