Welcome to Fairyfly’s documentation!¶
Fairyfly is a collection of Python libraries to create representations of construction details following fairyfly-schema.
This package is the core library that provides fairyfly’s common functionalities. To extend these functionalities you should install available Fairyfly extensions or write your own.
Installation¶
To install the core library try pip install -U fairyfly-core.
To check if the Fairyfly command line interface is installed correctly try fairyfly viz and you
should get a viiiiiiiiiiiiizzzzzzzzz! back in response!
Documentation¶
This document includes Fairyfly API documentation and
Fairyfly Command Line Interface documentation for fairyfly core and does
not include the documentation for fairyfly extensions. For each extension refer to
extension’s documentation page.
Here are a number of Fairyfly popular extensions:
CLI Docs¶
For command line interface documentation and API documentation see the pages below.