Skip to content

Commit 175bf05

Browse files
CHORE: Handle fpdf2 in CI and extend README (#6841)
Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent 05ac9d5 commit 175bf05

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

.github/workflows/ci_cd.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,8 @@ jobs:
176176
target: 'all'
177177
attest-provenance: true
178178
use-python-cache: false
179+
whitelist-license-check: 'fpdf2'
180+
179181
- name: Import python package
180182
shell: bash
181183
env:

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,17 @@ You can install PyAEDT on CPython 3.8 through 3.12 from PyPI with this command:
4848
pip install pyaedt
4949
```
5050

51-
Install PyAEDT with all extra packages (matplotlib, numpy, pandas, pyvista):
51+
Install PyAEDT with all extra packages (matplotlib, numpy, pandas, pyvista, ...):
5252

5353
```sh
5454
pip install pyaedt[all]
5555
```
5656

57+
> **Note:**
58+
The [all] installation target includes `fpdf2` for PDF export functionality, which is
59+
under license LGPL v3. For license-sensitive environments, install PyAEDT without [all]
60+
and add dependencies individually.
61+
5762
You can also install PyAEDT from Conda-Forge with this command:
5863

5964
```sh
@@ -305,6 +310,11 @@ On any Windows client machine:
305310

306311
PyAEDT is licensed under the MIT license.
307312

313+
PyAEDT provides an optional PDF export feature via the class `AnsysReport`.
314+
It requires the [fpdf2](https://github.com/py-pdf/fpdf2)
315+
library, which is licensed under the
316+
[GNU Lesser General Public License v3.0 (LGPLv3)](https://www.gnu.org/licenses/lgpl-3.0.en.html#license-text).
317+
308318
PyAEDT makes no commercial claim over Ansys whatsoever. This library extends the
309319
functionality of AEDT by adding a Python interface to AEDT without changing the
310320
core behavior or license of the original software. The use of PyAEDT requires a
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Handle fpdf2 in CI and extend README

0 commit comments

Comments
 (0)