You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-3Lines changed: 39 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,33 @@
7
7
_Tapir_ provides a collection of tooling to assist the usage of the JSON API of Archicad.
8
8
_Perisso_ is a Python package based on this fantastic work and aims to make it even easier to interact with and manipulate digital architectural model elements, by employing a fluent interface. This includes offering an efficient way to filter elements based on various criteria.
9
9
10
+
11
+
## Installation
12
+
13
+
1. Make sure you have the Tapir plugin for Archicad installed.
14
+
2. Install `perisso`.
15
+
My recommendation: Always use [uv](https://docs.astral.sh/uv/). Use it for everything.
16
+
17
+
```bash
18
+
uv venv
19
+
uv pip install perisso
20
+
```
21
+
22
+
Alternatively, you just download the source files. Oldschool.
23
+
24
+
10
25
> [!WARNING]
11
26
> Perisso is under development. Please expect breaking changes between versions.
12
27
28
+
13
29
## Usage
14
30
15
-
Here is a basic example of how to use the `perisso` package:
31
+
The simplest way is to just call `perisso()`. This will select all elements by default. To limit the elements to the current selection in Archicad use the `selection` parameter:
> The resulting element list is compatible with Tapir, but _not_ with the native [Archicad-Python connection](https://pypi.org/project/archicad/).
48
+
For that you need to call the `toNative()` function on the perisso collection. The result uses the classes of the AC-Py connection and can then be fed into it.
49
+
50
+
51
+
See the [examples](https://github.com/runxel/perisso/tree/main/examples) for more.
52
+
53
+
54
+
> [!NOTE]
55
+
> If a filter does _not_ apply the element concerned is silently removed (not _included_ in the result, that is). Example: A Property is not used on it.
56
+
57
+
58
+
## Contributing
59
+
60
+
Please open an issue or submit a pull request for any enhancements or bug fixes. Contributions are welcome, but might not be accepted until `perisso` reached a somewhat stable state.
0 commit comments