Various tidyups and rewordings of docs.

MANIFEST.in

@@ -1,3 +1,3 @@
-include README.rst
+include README.md
 include LICENSE.txt
 recursive-include vtkplotlib/data *

TODO.md

@@ -1,19 +1,15 @@
 # Stuff that needs sorting
 
-- DOCS
-- Make `vpl.view` less useless.
-- Add type and array shape checking.
-- Use resize events in `vpl.text` so that it scales with the window.
-- Edit `TextureMap` so that it doesn't flip the image. Or better, use VTK's.
-- Move the mapper to the `PolyData` class.
-- Add a `quick_show()` method to `BasePlot`.
-- Sort the `mapper.SetScalarMode` hoohah.
-- Implement a `write` in image_io.py.
-- Fix test_optional_dependency_fallbacks.py so that it actually ignores the optional libraries. I think this requires all `LIBRARY_AVAILABLE` bool variables to become functions rather than attributes.
-- Make `PolyData` not use  `deepcopy` in `numpy_to_vtk`.
-- Add _vtk_errors.py handling to image_io.py.
-- Add `cmap` as a `property` of `BasePlot`.
-- `mesh_plot` the pycollada and meshio classes.
-- Change `plot.set_scalar_range` to a `property`.
-- Fix cleanup of figures so it doen't issue the warnings on close. I think this is just `QtFigure`.
+- [ ] More DOCS
+- [ ] Make `vpl.view` less useless.
+- [ ] Add type and array shape checking.
+- [ ] Use resize events in `vpl.text` so that it scales with the window.
+- [ ] Edit `TextureMap` so that it doesn't flip the image. Or better, use VTK's.
+- [ ] Fix test_optional_dependency_fallbacks.py so that it actually ignores the optional libraries. I think this requires all `LIBRARY_AVAILABLE` bool variables to become functions rather than attributes.
+- [ ] Add _vtk_errors.py handling to image_io.py.
+- [ ] `mesh_plot` the pycollada and meshio classes.
+- [x] Fix cleanup of figures so it doen't issue the warnings on close. I think this is just `QtFigure`.
+- [x] Work out why QtFigures are no longer re-showable.
+- [ ] Setup a Qt/VTK abstracted timer for animation use (using a VTK timer crashes when Qt is used).
+- [ ] Document accessable VTK attributes so people VTK savy users can find them.
 

contributing.md

@@ -71,5 +71,5 @@ If you want to join the team then cool - you're hired! Again, email me. You will
 
 ## Donations 
 
-If this library has helped you and you want to throw some cash at someone then you can say thanks by giving to [these charities](https://uk.virginmoneygiving.com/Team/vtkplotlib).
+If this library has helped you and you want to throw some cash at someone then  [these](https://uk.virginmoneygiving.com/Team/vtkplotlib) are a couple of my favourite charities.
 

docs/source/quickstart.rst

@@ -4,10 +4,15 @@ Introduction
 
 ..
     This site auto-generates the little python version badges from url.
-    The required  format is
-    https://img.shields.io/badge/[text_block_1]-[text_block_2]-[html_color].svg
-    Characters need to be url escaped. [space] is %20 and | is %7C
-    "https://img.shields.io/badge/python-%20{}-blue.svg".format("%20%7C%20".join(["2.7", "3.5", "3.6", "3.7", "3.8", "PyInstaller"]))
+    The required  format is:
+    https://img.shields.io/badge/[text_block_1]-[text_block_2]-[html_named_color].svg
+
+    It helps to pad with spaces. Characters need to be url escaped (can be done
+    using urllib).
+
+    from urlib.parse import quote
+    "https://img.shields.io/badge/" + quote("python- {}-blue.svg".format(\
+                " | ".join(["2.7", "3.5", "3.6", "3.7", "3.8", "PyInstaller"])))
 
 .. image:: https://img.shields.io/badge/python-%202.7%20%7C%203.5%20%7C%203.6%20%7C%203.7%20%7C%203.8%20%7C%20PyInstaller-blue.svg
 

setup.py

@@ -22,11 +22,6 @@
       author_email='[email protected]',
       license='GNU version 3.0',
       packages=find_packages(),
-      # package_dir={'vtkplotlib': 'vtkplotlib'},
-#      package_data={'vtkplotlib': ['data/icons/*',
-#                                    'data/models/*']},
-      # data_files=[('icons', ['data/icons/*']),
-                  # ('models', ['data/models/*'])],
       include_package_data=True,
       install_requires=[
              "vtk",

vtkplotlib/plots/Text.py

@@ -114,7 +114,7 @@ def text(self, text_str):
 
 
 def resize_event_cb(*args):
-    print(args)
+    # print(args)
     self.actor.SetPosition(*(i // 2 for i in fig.render_size))