Merge pull request #254 from njustesen/feature/docker

Dockerfile and dependency version updates

Author: bermell

.github/workflows/pythonpackage.yml

@@ -1,6 +1,6 @@
 name: Python package
 
-on: [push, pull_request]
+on: [pull_request]
 
 jobs:
   build:
@@ -9,25 +9,30 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.7, 3.8, 3.9, '3.10']
+        python-version: [3.8, 3.9, '3.10', '3.11']
 
     steps:
     - uses: actions/checkout@v1
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v1
       with:
         python-version: ${{ matrix.python-version }}
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install . 
+        pip install -e .
+        python setup.py install
+
     - name: Lint with flake8
       run: |
         pip install flake8
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
     - name: Test with pytest
       run: |
         pip install pytest

Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3.9
+
+RUN pip install --upgrade pip
+
+WORKDIR /home/botbowl
+COPY requirements.txt ./
+RUN pip install -r requirements.txt
+
+COPY . .
+RUN python setup.py install
+
+WORKDIR /home/
+
+CMD ["python botbowl/examples/server_example.py"]

README.md

@@ -17,7 +17,17 @@ Please cite our paper if you use botbowl in your publications.
 Read more about the challenges and achievements in [Papers.md](docs/papers.md)
 
 ## Installation
-[Make sure python 3.6 or newer is installed, together with pip.](https://www.makeuseof.com/tag/install-pip-for-python/)
+
+### Quickstart with docker
+A docker image ready for playing in the web framework as well as doing bot development can be found at `mbermell/botbowl:latest`. To start a web server with docker run:
+```shell
+docker run -p 1234:1234 -t mbermell/botbowl
+```
+Go to: http://127.0.0.1:1234/
+
+### Installation with Pip
+
+[Make sure python 3.8 or newer is installed, together with pip.](https://www.makeuseof.com/tag/install-pip-for-python/)
 Then run:
 ```
 pip install git+https://github.com/njustesen/botbowl

examples/server_example.py

@@ -1,7 +1,15 @@
 #!/usr/bin/env python3
+import os
 from scripted_bot_example import *
 
 import botbowl.web.server as server
 
 if __name__ == "__main__":
-    server.start_server(debug=True, use_reloader=False, port=1234)
+    if os.path.exists("/.dockerenv"):
+        # If you're running in a docker container, you want the server to be accessible from outside the container.
+        host = "0.0.0.0"
+    else:
+        # If you're running locally, you want the server to be accessible from localhost only b/c of security.
+        host = "127.0.0.1"
+
+    server.start_server(host=host, debug=True, use_reloader=False, port=1234)

requirements.txt

@@ -1,36 +1,41 @@
-atomicwrites==1.3.0
-attrs==19.3.0
-certifi==2019.9.11
-chardet==3.0.4
-Click==7.0
-cloudpickle==1.2.2
-Cython==3.0.0a9
--e git+https://github.com/njustesen/botbowl.git@71383a54e36a165b6e52aafe00c2e6846336148c#egg=botbowl
-Flask==1.1.1
-future==0.18.2
-gym==0.15.4
-idna==2.8
-importlib-metadata==0.23
-itsdangerous==1.1.0
-Jinja2==2.11.3
-MarkupSafe==1.1.1
-matplotlib==3.2.0
-more-itertools==7.2.0
-numpy==1.17.4
-opencv-python==4.2.0.32
-packaging==19.2
-pluggy==0.13.0
-py==1.10.0
-pyglet==1.3.2
-pyparsing==2.4.5
-pytest==5.2.2
-python-interface==1.5.1
-requests==2.22.0
-scipy==1.3.2
-six==1.13.0
+certifi==2023.5.7
+charset-normalizer==3.1.0
+click==8.1.3
+cloudpickle==2.2.1
+contourpy==1.0.7
+cycler==0.11.0
+Cython==3.0.0b2
+defusedxml==0.7.1
+docker==6.1.1
+exceptiongroup==1.1.1
+Flask==2.3.2
+fonttools==4.39.3
+gym==0.26.2
+gym-notices==0.0.8
+idna==3.4
+importlib-metadata==6.6.0
+importlib-resources==5.12.0
+iniconfig==2.0.0
+itsdangerous==2.1.2
+Jinja2==3.1.2
+kiwisolver==1.4.4
+MarkupSafe==2.1.2
+matplotlib==3.7.1
+more-itertools==9.1.0
+numpy==1.24.3
+packaging==23.1
+Pillow==9.5.0
+pluggy==1.0.0
+pyparsing==3.0.9
+pytest==7.3.1
+python-dateutil==2.8.2
+python-interface==1.6.1
+requests==2.30.0
+six==1.16.0
 stopit==1.1.2
-untangle==1.1.1
-urllib3==1.26.5
-wcwidth==0.1.7
-Werkzeug==0.16.0
-zipp==0.6.0
+tomli==2.0.1
+untangle==1.2.1
+urllib3==2.0.2
+websocket-client==1.5.1
+Werkzeug==2.3.3
+zipp==3.15.0

setup.py

@@ -4,6 +4,16 @@
 from distutils.ccompiler import new_compiler
 from distutils.errors import DistutilsPlatformError
 
+# warn user if setup.py is run from a different directory
+dir_of_file = os.path.dirname(__file__)
+cwd = os.getcwd()
+if dir_of_file != cwd:
+    # We should make this warning obsolete..
+    print(f"WARNING: setup.py is being run from a different directory than the install script. This can cause strange errors"
+          f"Current directory='{cwd}', dir of file='{dir_of_file}'")
+
+
+
 try:
     error_msg = None
     from Cython.Build import cythonize
@@ -35,23 +45,24 @@
 files_to_compile = ["botbowl/core/pathfinding/cython_pathfinding.pyx"]
 
 install_requires_packages = [
-          'numpy',
-          'untangle',
-          'Flask',
-          'gym==0.21.0',
-          'Jinja2',
-          'python-interface',
-          'stopit',
-          'requests',
-          'Cython >= 3.0a7',
-          'pytest',
-          'matplotlib',
-          'more_itertools'
+          'numpy==1.24.3',
+          'untangle==1.2.1',
+          'Flask==2.3.2',
+          'gym==0.26.2',
+          'Jinja2==3.1.2',
+          'docker==6.1.1',
+          'python-interface==1.6.1',
+          'stopit==1.1.2',
+          'requests==2.30.0',
+          'Cython==3.0.0b2',
+          'pytest==7.3.1',
+          'matplotlib==3.7.1',
+          'more_itertools==9.1.0'
 ]
 
 kwargs = {
     'name': 'botbowl',
-    'version': '0.4.0',
+    'version': '1.1.0',
     'include_package_data': True,
     'install_requires': install_requires_packages,
     'packages': find_packages(),