setup.py cleanup (#58)

.pre-commit-config.yaml

@@ -30,7 +30,7 @@ repos:
     rev: 6.1.1  # pick a git hash / tag to point to
     hooks:
       - id: pydocstyle
-        exclude: ^(gymnasium/version.py)|(gymnasium/envs/)|(tests/)|(docs/)
+        exclude: ^(gymnasium/envs/)|(tests/)|(docs/)
         args:
           - --source
           - --explain

CODE_OF_CONDUCT.rst

@@ -1,13 +1,13 @@
-===================
+=================================
-Gymnasium Code of Conduct
+Farama Foundation Code of Conduct
-===================
+=================================
 
-Gymnasium is dedicated to providing a harassment-free experience for
+The Farama Foundation is dedicated to providing a harassment-free experience for
 everyone, regardless of gender, gender identity and expression, sexual
 orientation, disability, physical appearance, body size, age, race, or
 religion. We do not tolerate harassment of participants in any form.
 
-This code of conduct applies to all Gymnasium spaces (including Gist
+This code of conduct applies to all Farama Foundation repositories (including Gist
 comments) both online and off. Anyone who violates this code of
 conduct may be sanctioned or expelled from these spaces at the
 discretion of the moderators.
@@ -19,7 +19,7 @@ and abiding by these rules.
 -------------
 Our Standards
 -------------
-Members of the Gymnasium community are **open**, **inclusive**, and **respectful**.
+Members of the Farama Foundation community are **open**, **inclusive**, and **respectful**.
 Examples of behavior that contributes to a positive environment for our community include:
 
 * **Being open**. Members of the community are open to collaboration, whether it's on issues, PRs, problems, or otherwise
@@ -49,7 +49,7 @@ Members asked to stop any inappropriate behavior are expected to comply immediat
 ------------
 Consequences
 ------------
-If a participant engages in behavior that violates this code of conduct, the Gymnasium team may take any action they deem
+If a participant engages in behavior that violates this code of conduct, the Farama Foundation team may take any action they deem
 appropriate, including warning the offender or expulsion from the community.
 
 Thank you for helping make this a welcoming, friendly community for everyone.

LICENSE.md

@@ -1,22 +0,0 @@
-The MIT License
-
-Copyright (c) 2016 OpenAI
-Copyright (c) 2022 Farama Foundation
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

LICENSE.txt

@@ -0,0 +1,216 @@
+This repository is licensed as follows:
+All assets in this repository are the copyright of the Farama Foundation, except
+where prohibited. Contributors to the repository transfer copyright of their work
+to the Farama Foundation.
+
+Some code in this repository has been taken from other open source projects
+and was originally released under the MIT or Apache 2.0 licenses, with
+copyright held by another party. We've attributed these authors and they
+retain their copyright to the extent required by law. Everything else
+is owned by the Farama Foundation. The Secret Code font was also released under
+the MIT license by Matthew Welch (http://www.squaregear.net/fonts/).
+The MIT and Apache 2.0 licenses are included below.
+
+The Farama Foundation releases the elements of this repository they copyright to
+under the MIT license.
+
+--------------------------------------------------------------------------------
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+--------------------------------------------------------------------------------
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

README.md

@@ -1,7 +1,7 @@
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 <p align="center">
-    <img src="gymnasium-text.png" width="500px"/>
+    <img src="https://raw.githubusercontent.com/Farama-Foundation/Gymnasium/main/gymnasium-text.png" width="500px"/>
 </p>
 
 

gymnasium/__init__.py

@@ -2,7 +2,6 @@
 # isort: skip_file
 
 from gymnasium import error
-from gymnasium.version import VERSION as __version__
 
 from gymnasium.core import (
     Env,
@@ -20,6 +19,7 @@ import os
 import sys
 
 __all__ = ["Env", "Space", "Wrapper", "make", "spec", "register"]
+__version__ = "0.26.2"
 
 # Initializing pygame initializes audio connections through SDL. SDL uses alsa by default on all Linux systems
 # SDL connecting to alsa frequently create these giant lists of warnings every time you import an environment using

gymnasium/version.py

@@ -1 +0,0 @@
-VERSION = "0.26.2"

setup.py

@@ -1,10 +1,11 @@
 """Setups the project."""
 import itertools
-import re
 
 from setuptools import find_packages, setup
 
+
 def get_description():
+    """Gets the description from the readme."""
     with open("README.md") as file:
         long_description = ""
         header_count = 0
@@ -17,15 +18,18 @@ def get_description():
                 break
     return header_count, long_description
 
+
 def get_version():
-    """Gets the pettingzoo version."""
+    """Gets the gymnasium version."""
-    path = "gymnasium/version.py"
+    path = "gymnasium/__init__.py"
     with open(path) as file:
-        full_version = file.read()
+        lines = file.readlines()
-        assert (
+
-            re.match(r'VERSION = "\d\.\d+\.\d+"\n', full_version).group(0) == full_version
+    for line in lines:
-        ), f"Unexpected version: {full_version}"
+        if line.startswith("__version__"):
-        return re.search(r"\d\.\d+\.\d+", full_version).group(0)
+            return line.strip().split()[-1].strip().strip('"')
+    raise RuntimeError("bad version data in __init__.py")
+
 
 # Environment-specific dependencies.
 extras = {
@@ -51,33 +55,23 @@ extras["all"] = list(
     set(itertools.chain.from_iterable(map(lambda group: extras[group], all_groups)))
 )
 
+version = get_version()
 header_count, long_description = get_description()
 
 setup(
+    name="Gymnasium",
+    version=version,
     author="Farama Foundation",
     author_email="contact@farama.org",
-    classifiers=[
-        # Python 3.6 is minimally supported (only with basic gymnasium environments and API)
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.6",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-    ],
     description="A standard API for reinforcement learning and a diverse set of reference environments (formerly Gym)",
-    extras_require=extras,
+    url="https://gymnasium.farama.org/",
-    install_requires=[
-        "numpy >= 1.18.0",
-        "cloudpickle >= 1.2.0",
-        "importlib_metadata >= 4.8.0; python_version < '3.10'",
-        "gymnasium_notices >= 0.0.1",
-        "dataclasses == 0.8; python_version == '3.6'",
-    ],
     license="MIT",
+    license_files=("LICENSE.txt",),
     long_description=long_description,
     long_description_content_type="text/markdown",
-    name="gymnasium",
+    keywords=["Reinforcement Learning", "game", "RL", "AI", "gymnasium"],
+    python_requires=">=3.6",
+    tests_require=extras["testing"],
     packages=[
         package for package in find_packages() if package.startswith("gymnasium")
     ],
@@ -90,9 +84,23 @@ setup(
             "py.typed",
         ]
     },
-    python_requires=">=3.6",
+    include_package_data=True,
-    tests_require=extras["testing"],
+    install_requires=[
-    url="https://gymnasium.farama.org/",
+        "numpy >= 1.18.0",
-    version=get_version(),
+        "cloudpickle >= 1.2.0",
+        "importlib_metadata >= 4.8.0; python_version < '3.10'",
+        "gymnasium_notices >= 0.0.1",
+        "dataclasses == 0.8; python_version == '3.6'",
+    ],
+    classifiers=[
+        # Python 3.6 is minimally supported (only with basic gymnasium environments and API)
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+    ],
+    extras_require=extras,
     zip_safe=False,
 )