From 01e0a21306c96da7545b4ebb3148c910557bf05b Mon Sep 17 00:00:00 2001
From: kmarsteller <keith.g.marsteller@nasa.gov>
Date: Thu, 30 Aug 2018 23:40:58 -0400
Subject: [PATCH] adding a few more things to the repo, tests, and api, flesh
 out readme

---
 .travis.yml                                |   2 +-
 README.md                                  |  13 +++++++++++++
 your_project/api.py                        |   4 ++++
 your_project/source/example.py             |   2 +-
 your_project/source/tests/__init__.py      |   0
 your_project/source/tests/__init__.pyc     | Bin 0 -> 161 bytes
 your_project/source/tests/test_example.py  |   9 +++++++++
 your_project/source/tests/test_example.pyc | Bin 0 -> 765 bytes
 8 files changed, 28 insertions(+), 2 deletions(-)
 create mode 100644 your_project/api.py
 create mode 100644 your_project/source/tests/__init__.py
 create mode 100644 your_project/source/tests/__init__.pyc
 create mode 100644 your_project/source/tests/test_example.py
 create mode 100644 your_project/source/tests/test_example.pyc

diff --git a/.travis.yml b/.travis.yml
index 52ddf00..6e756ef 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -16,7 +16,7 @@ language: generic
 addons:
   apt:
     sources:
-    - ubuntu-toolchain-r-test
+    - ubuntu-toolchain-r-tests
     packages:
     - gfortran
     - libblas-dev
diff --git a/README.md b/README.md
index 63b9463..4d39108 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
 # library_template
 A structure that can be a starting point for developers who want to create projects that depend on OpenMDAO.
+
+This is the simplest working repository. 
+
+This sample repo is fully installable using:
+`pip install -e .`
+
+You can build the docs by changing into `your_project/docs` and typing:
+`make clean; make all`
+
+If you have installed testflo (`pip install testflo`), you can run the tests with:
+`testflo`
+
+Use this working example to build your own repository!
\ No newline at end of file
diff --git a/your_project/api.py b/your_project/api.py
new file mode 100644
index 0000000..f894833
--- /dev/null
+++ b/your_project/api.py
@@ -0,0 +1,4 @@
+"""Key your_project classes can be imported from here."""
+
+# source
+from your_project.source.example import Example
\ No newline at end of file
diff --git a/your_project/source/example.py b/your_project/source/example.py
index a87c35f..351b55b 100644
--- a/your_project/source/example.py
+++ b/your_project/source/example.py
@@ -1,3 +1,3 @@
 class Example(object):
     def __init__(self):
-        pass
\ No newline at end of file
+        self.x = 1
diff --git a/your_project/source/tests/__init__.py b/your_project/source/tests/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/your_project/source/tests/__init__.pyc b/your_project/source/tests/__init__.pyc
new file mode 100644
index 0000000000000000000000000000000000000000..69e5cd548bd27d902272f35290740aa957852fd2
GIT binary patch
literal 161
zcmZSn%*z$Lr6W3-0SXv_v;z<qvjB+{28Lh_kcgiKkYGR~ioJkh`k}?CMaBBrxrs%^
zC8;_3;rT_``Z<|NMTtd~@g=Fb1v!Z&srr@qrA6@tMfq8&$tC*5Ku&V1eo1O^iGF;1
fW?p7Ve7s&kWeEq+IGf!3l+v73JCLQtK+FIDhIS{5

literal 0
HcmV?d00001

diff --git a/your_project/source/tests/test_example.py b/your_project/source/tests/test_example.py
new file mode 100644
index 0000000..6e2fcab
--- /dev/null
+++ b/your_project/source/tests/test_example.py
@@ -0,0 +1,9 @@
+import unittest
+from your_project.api import Example
+
+
+class TestExample(unittest.TestCase):
+
+    def test___init___simple(self):
+        ex = Example()
+        self.assertEqual(ex.x, 1)
\ No newline at end of file
diff --git a/your_project/source/tests/test_example.pyc b/your_project/source/tests/test_example.pyc
new file mode 100644
index 0000000000000000000000000000000000000000..d60c60aef1e3e70a75ae0fd2d888be1363008010
GIT binary patch
literal 765
zcmchU!AiqG5Qb-yTD2-D_y8VzYR-a)SbD9{Dq=h=YqEv3NfWaZXhBc);1hZBt$YCe
zXIs=4(2$v(VRvS~`8WJH=)AwZ-Y2yALaY}scM6x{SCkXQ>o}lXQ4vrakV-?cMAMKa
ziqaOn5Uq&r;+9m5yIZKvKJg8^3L$U94Hl-Ta?5*&udU-v{(ZF^yo9+UIP{Lun4~eT
z8;yORM9u^-!R*7_2^{;opA|g;2wu@N5R8>z5@@7im`QC{3P&*V7{)nU^Wd>DIm`CK
zALSN8XY&b5p<Q(0$vbz2D7rzBi)MwX9osy*E$dm7XAiZhmzphRG;E_~+0?qK%c)H`
za!3*zF{XCjYr7VsS1tJ%J!MC0oy{{@TqZ(^W=>E@?J5t>J4m#io5E_%9iJ3s+T=(_
zZKOY>e}+2}o#c6)h|>=IQ+u!m@G=J<V&nJtJyT_C&4pi{zHglMjs5}Hvz@JFIv04a
J>ApG)zW_o^w!#1a

literal 0
HcmV?d00001