Python package
ra.boutique
The Boutique: ready-made designs (solitaires, trilogies, halos, bands, earrings…) grouped in collections that are downloaded from the RhinoArtisan catalog to this computer and imported into the document like the Boutique window does.
import rhinoartisan as ra
Wraps ArtisanPlugin.Scripting.BoutiqueApi.
Functions
| Function | |
|---|---|
catalog() | The kits of the online Boutique catalog (rhinoartisan.com), each with whether it is installed and up to date. |
designs() | The designs of the Boutique collections installed on this computer. |
download() | Downloads and installs Boutique kits from the online catalog: the ones named in names (kit name or folder), or, when omitted, every kit not installed yet or updated since. |
insert() | Imports a Boutique design into the document, like the Boutique window’s Open: design is its id or SKU (collection, a name or folder, narrows the search when several collections use the same one). |
ra.boutique.catalog()
ra.boutique.catalog() -> List[BoutiqueKit]
The kits of the online Boutique catalog (rhinoartisan.com), each with whether it is installed and up to date. Needs the internet; read-only.
ra.boutique.designs()
ra.boutique.designs(query=None, collection=None) -> List[BoutiqueCatalogDesign]
The designs of the Boutique collections installed on this computer. query keeps those whose collection, name, description, SKU or id contain every word of it (case-insensitive); collection keeps one collection (name or folder). Read-only. Install more collections with Download().
| Parameter | Type | |
|---|---|---|
query | str | optional — None = the tool default |
collection | str | optional — None = the tool default |
ra.boutique.download()
ra.boutique.download(names=None) -> List[BoutiqueKit]
Downloads and installs Boutique kits from the online catalog: the ones named in names (kit name or folder), or, when omitted, every kit not installed yet or updated since. An update replaces the kit’s folder. Returns the kits installed. Needs the internet.
| Parameter | Type | |
|---|---|---|
names | Sequence[str] | optional — None = the tool default |
ra.boutique.insert()
ra.boutique.insert(design: str, collection=None, metal=None) -> List[str]
Imports a Boutique design into the document, like the Boutique window’s Open: design is its id or SKU (collection, a name or folder, narrows the search when several collections use the same one). metal WHITE, YELLOW or ROSE also sets the document’s metal to that 18K gold, as the window’s metal selector does. Returns the ids of the imported objects.
| Parameter | Type | |
|---|---|---|
design | str | required |
collection | str | optional — None = the tool default |
metal | str | optional — None = the tool default |