Merge pull request #124 from arcondello/deprecate-library

Deprecate dwavebinarycsp

README.rst

@@ -1,9 +1,10 @@
+:warning: *dwavebinarycsp* is deprecated. For solving problems with constraints,
+    we recommend using the hybrid solvers in the Leap :tm: service. You can find
+    documentation for the hybrid solvers at https://docs.ocean.dwavesys.com.
+
 .. image:: https://img.shields.io/pypi/v/dwavebinarycsp.svg
     :target: https://pypi.org/project/dwavebinarycsp
 
-.. image:: https://ci.appveyor.com/api/projects/status/b99rhw0l6ljsgw5t?svg=true
-    :target: https://ci.appveyor.com/project/dwave-adtt/dwavebinarycsp
-
 .. image:: https://codecov.io/gh/dwavesystems/dwavebinarycsp/branch/master/graph/badge.svg
     :target: https://codecov.io/gh/dwavesystems/dwavebinarycsp
 

docs/index.rst

@@ -6,6 +6,13 @@
 D-Wave Binary CSP
 =================
 
+.. deprecated:: 0.3.1
+
+    ``dwavebinarycsp`` is deprecated and will be removed in Ocean 10.
+    For solving problems with constraints, we recommand using the hybrid
+    solvers in the Leap service.
+    You can find documentation for the hybrid solvers at :ref:`using_hybrid`.
+
 .. include:: README.rst
   :start-after: index-start-marker
   :end-before: index-end-marker

docs/intro.rst

@@ -4,6 +4,13 @@
 Introduction
 ============
 
+.. deprecated:: 0.3.1
+
+    ``dwavebinarycsp`` is deprecated and will be removed in Ocean 10.
+    For solving problems with constraints, we recommand using the hybrid
+    solvers in the Leap service.
+    You can find documentation for the hybrid solvers at :ref:`using_hybrid`.
+
 `dwavebinarycsp` is a library to construct a binary quadratic :term:`model` from a constraint
 satisfaction problem (CSP) with small constraints over binary variables (represented
 as either binary values {0, 1} or spin values {-1, 1}).

docs/reference/compilers.rst

@@ -4,6 +4,13 @@
 Converting to a Binary Quadratic Model
 ======================================
 
+.. deprecated:: 0.3.1
+
+    ``dwavebinarycsp`` is deprecated and will be removed in Ocean 10.
+    For solving problems with constraints, we recommand using the hybrid
+    solvers in the Leap service.
+    You can find documentation for the hybrid solvers at :ref:`using_hybrid`.
+
 Constraint satisfaction problems can be converted to binary quadratic models to be solved
 on samplers such as the D-Wave system.
 

docs/reference/constraint.rst

@@ -4,6 +4,13 @@
 Defining Constraints
 ====================
 
+.. deprecated:: 0.3.1
+
+    ``dwavebinarycsp`` is deprecated and will be removed in Ocean 10.
+    For solving problems with constraints, we recommand using the hybrid
+    solvers in the Leap service.
+    You can find documentation for the hybrid solvers at :ref:`using_hybrid`.
+
 .. automodule:: dwavebinarycsp.core.constraint
 
 Class

docs/reference/csp.rst

@@ -4,6 +4,13 @@
 Defining Constraint Satisfaction Problems
 =========================================
 
+.. deprecated:: 0.3.1
+
+    ``dwavebinarycsp`` is deprecated and will be removed in Ocean 10.
+    For solving problems with constraints, we recommand using the hybrid
+    solvers in the Leap service.
+    You can find documentation for the hybrid solvers at :ref:`using_hybrid`.
+
 .. automodule:: dwavebinarycsp.core.csp
 
 Class

docs/reference/factory_constraints.rst

@@ -4,6 +4,13 @@
 Factories
 =========
 
+.. deprecated:: 0.3.1
+
+    ``dwavebinarycsp`` is deprecated and will be removed in Ocean 10.
+    For solving problems with constraints, we recommand using the hybrid
+    solvers in the Leap service.
+    You can find documentation for the hybrid solvers at :ref:`using_hybrid`.
+
 `dwavebinarycsp` currently provides factories for constraints representing
 Boolean gates and satisfiability problems and CSPs for circuits and satisfiability
 problems.

docs/reference/loading.rst

@@ -4,6 +4,13 @@
 Other CSP Formats
 =================
 
+.. deprecated:: 0.3.1
+
+    ``dwavebinarycsp`` is deprecated and will be removed in Ocean 10.
+    For solving problems with constraints, we recommand using the hybrid
+    solvers in the Leap service.
+    You can find documentation for the hybrid solvers at :ref:`using_hybrid`.
+
 DIMACS
 ======
 

docs/reference/reduction.rst

@@ -4,6 +4,13 @@
 Reducing Constraints
 ====================
 
+.. deprecated:: 0.3.1
+
+    ``dwavebinarycsp`` is deprecated and will be removed in Ocean 10.
+    For solving problems with constraints, we recommand using the hybrid
+    solvers in the Leap service.
+    You can find documentation for the hybrid solvers at :ref:`using_hybrid`.
+
 .. automodule:: dwavebinarycsp.reduction
 .. currentmodule:: dwavebinarycsp
 

docs/sdk_index.rst

@@ -4,6 +4,13 @@
 dwavebinarycsp
 ==============
 
+.. deprecated:: 0.3.1
+
+    ``dwavebinarycsp`` is deprecated and will be removed in Ocean 10.
+    For solving problems with constraints, we recommand using the hybrid
+    solvers in the Leap service.
+    You can find documentation for the hybrid solvers at :ref:`using_hybrid`.
+
 .. include:: README.rst
    :start-after: index-start-marker
    :end-before: index-end-marker

dwavebinarycsp/__init__.py

@@ -12,6 +12,8 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
+from warnings import warn as _warn  # so it doesn't get pulled in by import *
+
 __version__ = '0.3.0'
 
 from dwavebinarycsp.compilers import *
@@ -41,3 +43,11 @@
 def assert_penaltymodel_factory_available():
     """Legacy - does nothing."""
     pass
+
+
+_warn("dwavebinarycsp is deprecated and will be removed in Ocean 10. "
+      "For solving problems with constraints, "
+      "we recommend using the hybrid solvers in the Leap service. "
+      "You can find documentation for the hybrid solvers at https://docs.ocean.dwavesys.com.",
+      category=DeprecationWarning,
+      stacklevel=2)