Animation and ColorRamp fixes (#32)

* new test for animation -- not complete yet.

* added color ramp tpo test .. broken.

* cleaned up the examples, and added an auto-run script

* cleaned up and automated the examples page.

* got a multiple color animation test to work.

* fixed some lint

* put the checksums in a python file, added more checks for animation files
cleaned up some lint

* removed duplicate file name

Author: ChrisBarker-NOAA

.flake8

@@ -13,3 +13,5 @@ exclude =
   conf.py
   build
   dist
+  ./build_gd.py
+  checksums.py

.github/workflows/conda_test.yml

@@ -1,4 +1,4 @@
-name: Run tests with miniconda
+name: Run tests with miniforge
 on: [push]
 
 jobs:
@@ -36,6 +36,11 @@ jobs:
         run: |
             pytest --pyargs py_gd
 
+      - name: Test Examples
+        shell: bash -l {0}
+        run: |
+            python docs/examples/run_all_examples.py
+
   lint:
     name: Flake8 linting
     runs-on: "ubuntu-latest"

.gitignore

@@ -1,7 +1,8 @@
 #specific to this repo:
 
 py_gd/py_gd.c
-docs/examples/Mandelbrot.png
+docs/examples/*.png
+docs/examples/*.gif
 
 
 # mac files

build_gd.py

@@ -11,7 +11,6 @@
 look in the "if __name__" clause at the bottom:
   you can turn on and off different libs, and different parts of the process
 
-
 """
 
 import os
@@ -24,7 +23,7 @@
 # use this if you want the full install of hdf and netcdf available on your system
 # prefix = "/usr/local"
 
-print "Installing libs to:", prefix
+print("Installing libs to:", prefix)
 
 if not os.path.exists(prefix):
     os.mkdir(prefix)
@@ -37,7 +36,7 @@ def download(name):
 
     # see if it's already there:
     if os.path.isfile(name):
-        print "%s already there -- not downloading again"%name
+        print("%s already there -- not downloading again"%name)
         return 
 
     ## note: bitbucket does not seem t o support direct download links liek this
@@ -53,18 +52,18 @@ def download(name):
         cmd = 'curl -L --output {0} http://sourceforge.net/projects/libpng/files/libpng16/1.6.3/libpng-1.6.3.tar.gz'.format(name)
     else:
         raise Exception("I don't know how to download: %s"%name)
-    print "downloading:", name
-    print cmd
+    print("downloading:", name)
+    print(cmd)
 
     os.system(cmd)
 
 def unpack(lib):
     if os.path.isdir(lib):
-        print "%s already unpacked, not unpacking again"%lib
+        print("%s already unpacked, not unpacking again"%lib)
         return 
     lib = lib +'.tar.gz'
     cmd = "tar -xvf "+lib
-    print "Unpacking:", cmd
+    print("Unpacking:", cmd)
     os.system( cmd )
 
 def configure(lib):
@@ -83,7 +82,7 @@ def configure(lib):
     conf = './configure ' + ' '.join(flags)
 
     os.chdir(lib)
-    print conf
+    print(conf)
     os.system("make clean")
     if os.system(conf):
         os.chdir(cwd)

conda_requirements_dev.txt

@@ -3,5 +3,5 @@ setuptools
 cython>=3
 pytest
 sphinx
-
+ipython  # nice to have, and used to help render the docs
 

docs/conf.py

@@ -28,10 +28,12 @@
 extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.todo',
               'sphinx.ext.coverage',
+              'IPython.sphinxext.ipython_directive'
               # 'sphinx.ext.pngmath',
               # 'sphinx.ext.mathjax',
               ]
-
+# extensions = ['IPython.sphinxext.ipython_console_highlighting',
+#               'IPython.sphinxext.ipython_directive']
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/examples/ultra_simple.py docs/examples/0-ultra_simple.pydocs/examples/ultra_simple.py renamed to docs/examples/0-ultra_simple.py

@@ -1,5 +1,5 @@
 """
-ultra_simple_example.py
+Ultra Simple Example
 
 About the simplest example for py_gd
 
@@ -12,5 +12,5 @@
 
 img.draw_line((1, 1), (400, 300), color='red', line_width=10)
 
-img.save('ultra_simple.png', 'png')
+img.save('0-ultra_simple.png', 'png')
 

docs/examples/Mandelbrot.png

@@ -0,0 +1,51 @@
+
+from pathlib import Path
+
+HERE = Path(__file__).parent
+
+HEADER = """.. _sample_scripts:
+
+Sample Scripts
+==============
+
+A good way to learn to use py_gd is to check out a few example scripts.
+
+"""
+
+all_examples = [fn for fn in HERE.glob("*.py") if not fn.name in {"build_color_images.py",
+                                                                  "run_all_examples.py",
+                                                                  "build_example_page.py"}
+                                                                  ]
+
+def gen_example(script_path):
+    if "draw_dots" in str(script_path.stem):
+        img_filename = str(script_path.stem) + ".gif"
+    else:
+        img_filename = str(script_path.stem) + ".png"
+
+    docstring = []
+    with open(script_path) as script:
+        # find the docstring
+        for line in script:
+            if line.startswith('"""'):
+                break
+        for line in script:
+            line = line.strip()
+            if line.startswith('"""'):
+                break
+            else:
+                docstring.append(line)
+    section = f"""
+
+{docstring[0]}\n{"-"*len(docstring[0])}
+{"\n".join(docstring[1:])}
+
+.. image:: examples/{img_filename}
+    :align: center
+    """
+    return section
+
+with open(HERE / "../sample_scripts.rst", 'w') as rst:
+    rst.write(HEADER)
+    for script in all_examples:
+        rst.write(gen_example(script))