DOC: End of life

Add end-of-life notices to documentation

Author: bashtage

README.md

@@ -4,6 +4,27 @@
 [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/odc5c4ukhru5xicl/branch/master?svg=true)](https://ci.appveyor.com/project/bashtage/ng-numpy-randomstate/branch/master)
 [![PyPI version](https://badge.fury.io/py/randomstate.svg)](https://badge.fury.io/py/randomstate)
 
+# Future development in [randomgen](https://github.com/bashtage/randomgen)
+
+**End-of-life notification**
+
+This library was designed to bring alternative generators to the NumPy 
+infrastructure. It as been successful in advancing the conversation 
+for a future implementation of a new random number API in NumPy which 
+will allow new algorithms and/or generators. The next step
+in this process is to separate the basic (or core RNG) from the 
+functions that transform random bits into useful random numbers.
+This has been implemented in a successor project  **randomgen** 
+available on [GitHub](https://github.com/bashtage/randomgen) or
+[PyPi](https://pypi.org/project/randomstate/).
+
+[randomgen](https://github.com/bashtage/randomgen) has a slightly different API, so please see the  [randomgen documentation](https://bashtage.github.io/randomgen).
+
+
+-----------------------------------------------------------------------
+
+## Introduction
+
 This is a library and generic interface for alternative random 
 generators in Python and NumPy. 
 

README.rst

@@ -3,6 +3,30 @@ randomstate
 
 |Travis Build Status| |Appveyor Build Status| |PyPI version|
 
+Future development in `randomgen <https://github.com/bashtage/randomgen>`__
+===========================================================================
+
+**End-of-life notification**
+
+This library was designed to bring alternative generators to the NumPy
+infrastructure. It as been successful in advancing the conversation for
+a future implementation of a new random number API in NumPy which will
+allow new algorithms and/or generators. The next step in this process is
+to separate the basic (or core RNG) from the functions that transform
+random bits into useful random numbers. This has been implemented in a
+successor project **randomgen** available on
+`GitHub <https://github.com/bashtage/randomgen>`__ or
+`PyPi <https://pypi.org/project/randomstate/>`__.
+
+`randomgen <https://github.com/bashtage/randomgen>`__ has a slightly
+different API, so please see the `randomgen
+documentation <https://bashtage.github.io/randomgen>`__.
+
+--------------
+
+Introduction
+------------
+
 This is a library and generic interface for alternative random
 generators in Python and NumPy.
 

doc/source/conf.py

@@ -64,7 +64,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '.'.join(map(str,LooseVersion(randomstate.__version__).version[:2]))
+version = '.'.join(map(str, LooseVersion(randomstate.__version__).version[:2]))
 # The full version, including alpha/beta/rc tags.
 release = randomstate.__version__
 
@@ -145,6 +145,9 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
+html_sidebars = {
+    '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html']
+}
 #html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
@@ -245,8 +248,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  (master_doc, 'randomstate.tex', 'randomstate Documentation',
-   'Kevin Sheppard', 'manual'),
+    (master_doc, 'randomstate.tex', 'randomstate Documentation',
+     'Kevin Sheppard', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -289,9 +292,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  (master_doc, 'randomstate', 'randomstate Documentation',
-   author, 'randomstate', 'NumPy-like random number generation supporting multiple core PRNG.',
-   'Random Numbers'),
+    (master_doc, 'randomstate', 'randomstate Documentation',
+     author, 'randomstate', 'NumPy-like random number generation supporting multiple core PRNG.',
+     'Random Numbers'),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -306,4 +309,4 @@
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
 
-autosummary_generate = True
+autosummary_generate = True

doc/source/index.rst

@@ -1,5 +1,27 @@
 randomstate's documentation
 ===========================
+
+.. warning::
+
+  **End-of-life notification**
+
+  This library was designed to bring alternative generators to the NumPy 
+  infrastructure. It as been successful in advancing the conversation 
+  for a future implementation of a new random number API in NumPy which 
+  will allow new algorithms and/or generators. The next step
+  in this process is to separate the basic (or core RNG) from the 
+  functions that transform random bits into useful random numbers.
+  This has been implemented in a successor project  **randomgen** 
+  available on `GitHub`_ or `PyPi`_.
+
+  `randomgen`_ has a slightly different API, so please see the  `randomgen documentation`_.
+
+.. _`GitHub`: https://github.com/bashtage/randomgen
+.. _`PyPi`: https://pypi.org/project/randomstate/
+.. _`randomgen`: https://github.com/bashtage/randomgen
+.. _`randomgen documentation`: https://bashtage.github.io/randomgen
+
+
 This package contains drop-in replacements for the NumPy RandomState object
 that change the core random number generator.
 

randomstate/__init__.py

@@ -59,6 +59,12 @@
 """
 from __future__ import division, absolute_import, print_function
 
+import warnings
+
+from randomstate._deprecated import (DEPRECATION_MESSAGE,
+                                     RandomStateDeprecationWarning)
+warnings.warn(DEPRECATION_MESSAGE, RandomStateDeprecationWarning)
+
 from randomstate.prng.mt19937 import *
 from randomstate.entropy import random_entropy
 import randomstate.prng

randomstate/_deprecated.py

@@ -0,0 +1,26 @@
+DEPRECATION_MESSAGE = """
+**End-of-life notification**
+
+This library was designed to bring alternative generators to the NumPy 
+infrastructure. It as been successful in advancing the conversation 
+for a future implementation of a new random number API in NumPy which 
+will allow new algorithms and/or generators. The next step
+in this process is to separate the basic (or core RNG) from the 
+functions that transform random bits into useful random numbers.
+This has been implemented in a successor project  **randomgen** 
+available on GitHub
+
+https://github.com/bashtage/randomgen
+
+or PyPi
+
+https://pypi.org/project/randomstate/.
+
+randomgen has a slightly different API, so please see the randomgen documentation
+
+https://bashtage.github.io/randomgen.
+"""
+
+
+class RandomStateDeprecationWarning(Warning):
+    pass

randomstate/randomstate.pyx

@@ -22,6 +22,8 @@ from cpython cimport Py_INCREF, PyComplex_FromDoubles, PyComplex_RealAsDouble, \
 
 
 import randomstate
+from randomstate._deprecated import (DEPRECATION_MESSAGE, 
+                                     RandomStateDeprecationWarning)
 from binomial cimport binomial_t
 from randomstate.entropy import random_entropy