Initial Commit

.gitignore

@@ -1,3 +1,13 @@
+# any video or other output file
+*.mp4
+*.gif
+
+# pycharm folder
+.idea/
+
+**/.DS_Store
+
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.travis.yml

@@ -0,0 +1,11 @@
+language: python
+python:
+  - "3.7"
+
+install:
+  - pip install .
+
+
+script:
+  - cd tests
+  - python test_suite.py

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include pyrecorder *.py

README.rst

@@ -0,0 +1,67 @@
+pyrecorder
+====================================================================
+
+You can find the detailed documentation here: https://www.egr.msu.edu/coinlab/blankjul/pyrecorder/
+
+
+|travis| |python| |license|
+
+
+.. |travis| image:: https://travis-ci.com/julesy89/pyrecorder.svg?branch=master
+   :alt: build status
+   :target: https://travis-ci.com/julesy/pyrecorder
+
+.. |python| image:: https://img.shields.io/badge/python-3.6-blue.svg
+   :alt: python 3.6
+
+.. |license| image:: https://img.shields.io/badge/license-apache-orange.svg
+   :alt: license apache
+   :target: https://www.apache.org/licenses/LICENSE-2.0
+
+
+
+Installation
+============
+
+The framework is available at the PyPi Repository:
+
+.. code-block:: bash
+
+    pip install -U pyrecorder
+
+
+Usage
+=====
+
+It's as simple as it can be. Initialize an `Video` object with a `Recorder` and record the current
+plots be calling `record()`. Finally, close the video object with `close()` and you are good to go
+and watch your video.
+
+.. code-block:: bash
+
+    fname = "example.mp4"
+    vid = Video(File(fname))
+
+    for k in range(10):
+        X = np.random.random((100, 2))
+        plt.scatter(X[:, 0], X[:, 1])
+        vid.record()
+
+    vid.close()
+
+
+
+Contact
+=======
+
+
+Feel free to contact me if you have any question:
+
+::
+
+    Julian Blank (blankjul [at] egr.msu.edu)
+    Michigan State University
+    Computational Optimization and Innovation Laboratory (COIN)
+    East Lansing, MI 48824, USA
+
+

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'pyrecorder'
+copyright = '2020, Julian Blank'
+author = 'Julian Blank'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['nbsphinx']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['**.ipynb_checkpoints']
+
+
+source_suffix = '.ipynb'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']