From c3a7b5b0860cb42a5b845f19812f149472e46a3d Mon Sep 17 00:00:00 2001 From: Dalai Felinto Date: Thu, 1 Dec 2016 16:44:25 +0100 Subject: [PATCH] .gitignore update --- .gitignore | 4 ++++ README.md | 16 +++++++++++++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index e69de29..e62c962 100644 --- a/.gitignore +++ b/.gitignore @@ -0,0 +1,4 @@ +*.pyc +*.blend[1-9] +__pycache__ +/dist/ diff --git a/README.md b/README.md index 2eb2d24..3dd01e5 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ Blender File ------------ -Documentation, examples and test yet to come. -Meanwhile you import the module with: +Module to inspect a .blend file from Python. +Basic usage can be grasped from the test suit. + +Import the module in your script and you are good to go: >>> import blender_file -This works for in both Python2.x and Python3.x. +This module supports both Python2.x and Python3.x at the moment. +Python 2.x support may be dropped in the future. + +### Test Suit + +To run the tests just do: + + >>> pip install pytest + >>> py.test tests/