Skip to content
This repository has been archived by the owner on Sep 18, 2021. It is now read-only.

Commit

Permalink
Improved docs and __init__
Browse files Browse the repository at this point in the history
  • Loading branch information
yni6 committed Apr 6, 2015
1 parent 92200d3 commit 260ddc0
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 10 deletions.
3 changes: 1 addition & 2 deletions docs/CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Changelog
CHANGELOG
=========


0.2.0 (2015-04-04)
------------------

Expand Down
15 changes: 8 additions & 7 deletions docs/README.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Instruction
===========
INTRODUCTION
============

The features described below come with the latest version
**0.2.0**. Earlier versions may not have some of the featrues.
**0.2.0**. Earlier versions may not have some of the features.

unishark extends unittest (to be more accurate, unittest2) in the
following ways:
Expand Down Expand Up @@ -84,10 +84,9 @@ To run it, simply add the following code:
program = unishark.DefaultTestProgram(dict_conf)
unishark.main(program)
And a HTML report is like:
A HTML report example can be found Here_.

.. image:: https://rawgit.com/twitter/unishark/master/docs/unishark_report_overview.png
.. image:: https://rawgit.com/twitter/unishark/master/docs/unishark_report_detail.png
.. _Here: https://github.com/twitter/unishark

Data Driven
-----------
Expand Down Expand Up @@ -162,4 +161,6 @@ by doing:
@unishark.data_driven(...)
...
For more details please visit the project home page: https://github.com/twitter/unishark and read README.md.
For more information please visit the Project_Home_ and read README.md.

.. _Project_Home: https://github.com/twitter/unishark
23 changes: 22 additions & 1 deletion unishark/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,28 @@
# Copyright 2015 Twitter, Inc and other contributors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

__all__ = ['DefaultTestLoader',
'out', 'BufferedTestResult', 'BufferedTestRunner',
'HtmlReporter', 'XUnitReporter',
'main', 'DefaultTestProgram',
'data_driven',
'ContextManager', 'contexts']

from unishark.runner import (out, BufferedTestResult, BufferedTestRunner)
from unishark.reporter import (Reporter, HtmlReporter, XUnitReporter)
from unishark.decorator import data_driven
from unishark.main import main, TestProgram, DefaultTestProgram
from unishark.main import (TestProgram, DefaultTestProgram, main)
from unishark.loader import DefaultTestLoader
from unishark.util import ContextManager, contexts

Expand Down

0 comments on commit 260ddc0

Please sign in to comment.