summaryrefslogtreecommitdiff
path: root/docs/overview/integrating.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/overview/integrating.rst')
-rw-r--r--docs/overview/integrating.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/overview/integrating.rst b/docs/overview/integrating.rst
new file mode 100644
index 00000000..e28df1a7
--- /dev/null
+++ b/docs/overview/integrating.rst
@@ -0,0 +1,32 @@
+Integrate cmd2 Into Your Project
+================================
+
+Once installed, you will want to ensure that your project's dependencies
+include ``cmd2``. Make sure your ``setup.py`` includes the following::
+
+ install_requires=[
+ 'cmd2>=1,<2',
+ ]
+
+The ``cmd2`` project uses `Semantic Versioning <https://semver.org>`_, which
+means that any incompatible API changes will be release with a new major
+version number. We recommend that you follow the advice given by the Python
+Packaging User Guide related to `install_requires
+<https://packaging.python.org/discussions/install-requires-vs-requirements/>`_.
+By setting an upper bound on the allowed version, you can ensure that your
+project does not inadvertently get installed with an incompatible future
+version of ``cmd2``.
+
+
+Windows Considerations
+-------------------------------
+
+If you would like to use :ref:`features/completion:Completion`, and you want
+your application to run on Windows, you will need to ensure you install the
+``pyreadline`` package. Make sure to include the following in your
+``setup.py``::
+
+ install_requires=[
+ 'cmd2>=1,<2',
+ ":sys_platform=='win32'": ['pyreadline'],
+ ]