/python-starter

A python starter project for Hypar.

Primary LanguagePythonMIT LicenseMIT

python-starter

A python starter project for Hypar.

The python-starter project is a python 3.6 module which references the Hypar SDK and uses the Hypar CLI to bootstrap your project.

Prerequisites

Getting Started

  • Fork this repository.
  • Clone your fork of the repository locally.
  • Edit the hypar.json to describe your function.

Test

Although not a strict requirement of Hypar, your code should have tests. The python-starter project uses Python's unittest module. To run the tests you can do the following:

cd test
python -m unittest

Preview

Hypar functions generate geometry in the form of glTF models. One of the tests will generate a model.glb at the root of the repository. GlTF models can be previewed using the online glTF viewer or using the glTF GitHub Chrome Extension which will show a preview button next to a .glb file in your repository.