Bump version (#390)

* Bump Python version to >=3.5 (#389) * Fix a couple typos (#345 and #346)
BYU-PCCL · Mar 12, 2020 · a63fc9b · a63fc9b
1 parent 7dcdd21
commit a63fc9b
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ Holodeck is a high-fidelity simulator for reinforcement learning built on top of
 ## Installation
 `pip install holodeck`
 
-(requires Python 3)
+(requires >= Python 3.5)
 
 See [Installation](https://holodeck.readthedocs.io/en/latest/usage/installation.html) for complete instructions (including Docker).
 

diff --git a/docs/changelog/changelog.rst b/docs/changelog/changelog.rst
@@ -41,14 +41,17 @@ New Features
 
 Changes
 ~~~~~~~
+
+- Holodeck now requires Python >= 3.5
+  (`#389 <https://github.com/BYU-PCCL/holodeck/issues/389>`_)
 - Moved weather/time methods from
   :class:`~holodeck.environments.HolodeckEnvironment` to new
   :class:`~holodeck.weather.WeatherController`
   (`#196 <https://github.com/BYU-PCCL/holodeck/issues/196>`_,
   `#263 <https://github.com/BYU-PCCL/holodeck/issues/263>`_)
 - Calling :meth:`~holodeck.environments.HolodeckEnvironment.send_world_command`
-  for an environment without the given command will now crash
-  the environment rather than fail silently.
+  for an environment without the given command will now cause
+  the environment to exit rather than fail silently.
   This includes all relevant methods in the
   :class:`~holodeck.weather.WeatherController`.
 

diff --git a/docs/usage/installation.rst b/docs/usage/installation.rst
@@ -4,14 +4,15 @@
 Installation
 ============
 
-Holodeck is installed in two portions: a client python library (``holodeck``) is
-installed first, which then downloads world packages. The python portion is very
-small, while the world packages ("binaries") can be several gigabytes.
+Holodeck is installed in two portions: a client python library (``holodeck``)
+is installed first, which then downloads world packages. The python portion is
+very small, while the world packages ("binaries") can be several gigabytes.
+
 
 Requirements
 ============
 
-- Python 3
+- >= Python 3.5
 - Several gigabytes of storage
 - pip3
 - Linux: OpenGL 3+
@@ -23,6 +24,14 @@ The latest stable Holodeck package is available in a pip repository:
 
 ``pip install holodeck``
 
+.. note::
+   On some Ubuntu systems a dependency of Holodeck (``posix-ipc``) can fail to
+   install if you do not have the ``python3-dev`` package installed.
+
+   .. code-block:: console
+
+      $ apt install python3-dev
+
 Install Client via git
 =======================
 
@@ -57,8 +66,8 @@ Currently the following tags are availible:
 .. _`pccl/holodeck`: https://hub.docker.com/r/pccl/holodeck
 
 .. note::
-   Holodeck cannot be run with root privileges, so the user ``holodeckuser`` with
-   password ``holodeck`` is provided in the docker image.
+   Holodeck cannot be run with root privileges, so the user ``holodeckuser``
+   with password ``holodeck`` is provided in the docker image.
 
 Managing World Packages
 =======================
@@ -88,15 +97,15 @@ Install a Package Automatically
 Installation Location
 ---------------------
 
-By default, Holodeck will install packages local to your user profile. See 
+By default, Holodeck will install packages local to your user profile. See
 :ref:`package-locations` for more information.
 
 Manually Installing a Package
 -----------------------------
 
 To manually install a package, you will be provided a ``.zip`` file.
-Simply extract it into the ``worlds`` folder in your
-Holodeck installation location (see :ref:`package-locations`)
+Extract it into the ``worlds`` folder in your Holodeck installation location 
+(see :ref:`package-locations`)
 
 .. note::
 

diff --git a/setup.py b/setup.py
@@ -15,7 +15,7 @@
     packages=find_packages('src'),
     package_dir={'': 'src'},
     license='MIT License',
-    python_requires=">=3",
+    python_requires=">=3.5",
     install_requires=[
         'posix_ipc >= 1.0.0; platform_system == "Linux"',
         'pywin32 >= 1.0; platform_system == "Windows"',

diff --git a/src/holodeck/environments.py b/src/holodeck/environments.py
@@ -505,6 +505,7 @@ def should_render_viewport(self, render_viewport):
 
     def set_render_quality(self, render_quality):
         """Adjusts the rendering quality of Holodeck.
+        
         Args:
             render_quality (:obj:`int`): An integer between 0 = Low Quality and 3 = Epic quality.
         """
-Original file line number
+Diff line change
@@ Expand Up / @@ -505,6 +505,7 @@ def should_render_viewport(self, render_viewport): @@
         def set_render_quality(self, render_quality):
             """Adjusts the rendering quality of Holodeck.
             Args:
                 render_quality (:obj:`int`): An integer between 0 = Low Quality and 3 = Epic quality.
             """
@@ Expand Down @@