-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from kmarsteller/master
adding a few more things to the repo, tests, and api, flesh out readme
- Loading branch information
Showing
8 changed files
with
28 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
"""Key your_project classes can be imported from here.""" | ||
|
||
# source | ||
from your_project.source.example import Example |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
class Example(object): | ||
def __init__(self): | ||
pass | ||
self.x = 1 |
Empty file.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
Binary file not shown.