Fix up README example

[ci skip]

CHANGELOG.md

@@ -1,44 +1,39 @@
+# flat-tree 0.0.1a9 (UNRELEASED)
+
+- Simplify CHANGELOG format
+
+# flat-tree 0.0.1a8 (2020-07-07)
+
+- Use colours in the README for more happiness
+- Made README clearer and added example
+
 # flat-tree 0.0.1a7 (UNRELEASED)
 
-# flat-tree 0.0.1a6 2020-07-07
+- **Experimenting with publishing and missed this release number**
 
-## Trivial/Internal Changes
-
-- Merge all tool configuration into the pyproject.toml
-
-## Removals
-
-- Removed RTD documentation
-
-## Trivial/Internal Changes
+# flat-tree 0.0.1a6 (2020-07-07)
 
 - Follow the Hypercore protocol renaming situation.
-- Migrate to git.autonomic.zone
+- Merge all tool configuration into the pyproject.toml
 - Migrate CI to drone.autonomic.zone
+- Migrate to git.autonomic.zone
 - Reduce package boilerplate
+- Removed RTD documentation
 
 # flat-tree 0.0.1a5 (2019-11-03)
 
-## Trivial/Internal Changes
-
-- Fixed documentation build errors.
 - Fixed changelog entry date and version.
+- Fixed documentation build errors.
 
 # flat-tree 0.0.1a4 (2019-11-03)
 
-## Improved Documentation
-
-- Use the sphinx_rtd_theme.
 - Attempt to clarify sections using better navigation.
+- Use the sphinx_rtd_theme.
 
 # flat-tree 0.0.1a3 (2019-07-01)
 
-## Removals
-
 - Don't advertise Python 3.5 which is not supported.
 
 # flat-tree 0.0.1a2 (2019-07-01)
 
-## Project Announcements
-
 - The first alpha development release is made!

README.md

@@ -4,10 +4,6 @@
 
 ## Utilities for navigating flat trees
 
-```sh
-$ pip install flat-tree
-```
-
 > Flat Trees are the core data structure that power Hypercore feeds. They allow
 > us to deterministically represent a tree structure as a vector. This is
 > particularly useful because vectors map elegantly to disk and memory. Because
@@ -15,3 +11,29 @@ $ pip install flat-tree
 > them. In effect this means that Flat Trees are a specific way of indexing
 > into a vector more than they are their own data structure. This makes them
 > uniquely efficient and convenient to implement in a wide range of languages.
+
+## Install
+
+```sh
+$ pip install flat-tree
+```
+
+## Example
+
+```python
+from flat_tree import FlatTreeIterator
+
+tree_iter = FlatTreeIterator()
+
+print("tree index: ", tree_iter.index)
+print("tree first parent: ", tree_iter.parent())
+print("tree next parent", tree_iter.parent())
+```
+
+Output:
+
+```sh
+tree index:  0
+tree first parent:  1
+tree next parent 3
+```

pyproject.toml

@@ -4,10 +4,10 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "flat-tree"
-version = "0.0.1a6"
+version = "0.0.1a8"
 description = "Utilities for navigating flat trees"
-authors = ["Decentral1se <hi@decentral1.se>"]
-maintainers = ["Decentral1se <hi@decentral1.se>"]
+authors = ["decentral1se <hi@decentral1.se>"]
+maintainers = ["decentral1se <hi@decentral1.se>"]
 license = "GPLv3"
 readme = "README.md"
 repository = "https://github.com/hyperpy/flat-tree"
@@ -62,7 +62,7 @@ commands = flake8 {posargs:--max-line-length 80} flat_tree/ test/
 [testenv:sort]
 skipdist = True
 deps = isort
-commands = isort {posargs:-c} -sp setup.cfg flat_tree/ test/
+commands = isort {posargs:-c} flat_tree/ test/
 
 [testenv:format]
 skipdist = True

test/test_version.py

@@ -1,10 +0,0 @@
-"""Version test module."""
-
-
-def test_version_fails_gracefully(mocker):
-    target = "pkg_resources.get_distribution"
-    mocker.patch(target, side_effect=Exception())
-
-    from flat_tree.__init__ import __version__
-
-    assert __version__ == "unknown"