Skip to content

Commit

Permalink
Overhaul for 4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
joowani committed May 10, 2018
1 parent 8119d0d commit 9bd927c
Show file tree
Hide file tree
Showing 16 changed files with 598 additions and 513 deletions.
15 changes: 6 additions & 9 deletions .travis.yml
Expand Up @@ -6,15 +6,12 @@ python:
- 3.5
- 3.6
install:
- pip install coverage
- pip install pytest
- pip install pytest-cov
- pip install python-coveralls
- pip install flake8
- python setup.py install
- pip install flake8 mock pytest pytest-cov python-coveralls sphinx sphinx_rtd_theme
- pip install .
script:
- python -m flake8 binarytree/__init__.py
- python -m doctest binarytree/__init__.py
- py.test tests.py --cov=binarytree
- python -m flake8
- python -m sphinx -b doctest docs build
- python -m sphinx -b html -W docs build
- py.test -s -v --cov=binarytree
after_success:
- coveralls
1 change: 1 addition & 0 deletions MANIFEST.in
@@ -1 +1,2 @@
include README.rst LICENSE
prune tests
20 changes: 7 additions & 13 deletions README.rst
Expand Up @@ -37,25 +37,22 @@ Are you studying binary trees for your next exam, assignment or technical interv

**Binarytree** is a Python library which provides a simple API to generate,
visualize, inspect and manipulate binary trees. It allows you to skip the
tedious work of setting up test data, and dive straight into practising
your algorithms! Heaps and BSTs (binary search trees) are also supported.
tedious work of setting up test data, and dive straight into practising your
algorithms. Heaps and BSTs (binary search trees) are also supported.

Announcements
=============

* **Binarytree** has been completely overhauled in version `3.0`_!
* **Binarytree** version `4.0`_ is now out!
* Please see the releases_ page for details on the latest updates.

.. _3.0: https://github.com/joowani/binarytree/releases/tag/3.0.0
.. _4.0: https://github.com/joowani/binarytree/releases/tag/4.0.0
.. _releases: https://github.com/joowani/binarytree/releases

Requirements
============

- Python 2.7, 3.4, 3.5 or 3.6
- Pip_ installer

.. _Pip: https://pip.pypa.io

Installation
============
Expand All @@ -73,7 +70,7 @@ To install the latest version directly from GitHub_:
~$ pip install -e git+git@github.com:joowani/binarytree.git@master#egg=binarytree
You may need to use ``sudo`` depending on your environment setup.
You may need to use ``sudo`` depending on your environment.

.. _PyPi: https://pypi.python.org/pypi/binarytree
.. _GitHub: https://github.com/joowani/binarytree
Expand Down Expand Up @@ -332,9 +329,7 @@ Traverse the trees using different algorithms:
`List representations`_ are also supported:

.. _List representations:
https://en.wikipedia.org/wiki/Binary_tree#Arrays

.. _List representations: https://en.wikipedia.org/wiki/Binary_tree#Arrays

.. code-block:: python
Expand Down Expand Up @@ -362,10 +357,9 @@ Check out the documentation_ for more details!

.. _documentation: http://binarytree.readthedocs.io/en/latest/index.html


Contributing
============

Please have a look at this page_ before submitting a pull request. Thanks!

.. _page: http://binarytree.readthedocs.io/en/latest/contributing.html
.. _page: http://binarytree.readthedocs.io/en/latest/contributing.html

0 comments on commit 9bd927c

Please sign in to comment.