github workflows, versioning, tests, refactor

Tamerlan Abilov · Tamerlan Abilov · commit e21891e63e4f · 2021-04-26T16:32:52.000+04:00
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -0,0 +1,34 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest
+        if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
+
+    - name: Test with pytest
+      run: |
+        pytest
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -0,0 +1,28 @@
+name: Pypi Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/README.md b/README.md
@@ -3,8 +3,8 @@
 
 ![Pygame integration example](example/sm-example.gif)
 
-
-#### TL;DR: Some basic 3D world playground with animations and [camera](#camera-keys-example) completely from scratch(only 2D pixels). 
+[![Tests](https://github.com/timabilov/python-play3d/actions/workflows/python-package.yml/badge.svg?event=push)](https://github.com/timabilov/python-play3d/actions/workflows/python-package.yml)
+#### TL;DR: Basic 3D world playground with animations and [camera](#camera-keys-example) completely from scratch(only 2D pixels). 
 This implementation / API only for demonstration and *playground* purposes based on [Perspective projection](https://en.wikipedia.org/wiki/3D_projection#Perspective_projection).     
 Can be used on top of **any** 2d graphics engine/lib(frame buffers, sdl and etc.)
 
@@ -17,6 +17,8 @@ Not implemented features due to low performance:
 
 Also you can plot any function on 3D scene.
 
+
+* [Install](#intall)
 * [How to use](#how-to-use)
 * [Model View Projection](#model-view-projection)
   * [Projection](#projection)
@@ -30,6 +32,10 @@ Also you can plot any function on 3D scene.
 * [Trajectory API](#trajectory-api)
 * [Pygame Example](#pygame-example)
 
+## Install
+
+`pip install play3d`
+
 ## How to use
 
 There is only one requirement - to provide 2D pixel and line renderer(drawer)
diff --git a/play3d/__about__.py b/play3d/__about__.py
@@ -0,0 +1,5 @@
+__version__ = "0.1.0"
+__author__ = "timabilov"
+__email__ = "timabilov33@gmail.com"
+__url__ = " https://github.com/timabilov/python-play3d"
+__license__ = "MIT License"
diff --git a/play3d/matrix.py b/play3d/matrix.py
@@ -76,6 +76,11 @@ def __add__(self, other):
     def __str__(self):
         return str(self.matrix)
 
+    def __eq__(self, other: 'Matrix'):
+        print('EHE?', self)
+        print(other)
+        return (self.matrix == other.matrix).all()
+
 
 def matmul(matrix1, matrix2):
     """
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -0,0 +1,2 @@
+-r requirements.txt
+pytest
diff --git a/setup.py b/setup.py
@@ -0,0 +1,41 @@
+from os.path import abspath, dirname, join
+
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+about: dict = {}
+here = abspath(dirname(__file__))
+with open(join(here, "play3d", "__about__.py")) as f:
+    exec(f.read(), about)
+
+setuptools.setup(
+    name="play3d",
+    version=about["__version__"],
+    author=about["__author__"],
+    author_email=about["__email__"],
+    url=about["__url__"],
+    license=about["__license__"],
+    packages=['play3d'],
+    install_requires=[line.strip() for line in open(join(here, "requirements.txt")).readlines()],
+    description="Basic 3D world playground with animations and completely from scratch.",
+    long_description=open(join(dirname(__file__), "README.md")).read(),
+    long_description_content_type="text/markdown",
+    keywords="python 3d play3d three_d projection mvp",
+    classifiers=[
+        "Development Status :: 1 - Planning",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Topic :: Software Development",
+        "Topic :: Education",
+        "Topic :: Scientific/Engineering :: Visualization",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+    ],
+)
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -0,0 +1,8 @@
+from pytest import fixture
+
+from play3d.models import Cube
+
+
+@fixture
+def cube():
+    return Cube()
diff --git a/tests/test_matrix.py b/tests/test_matrix.py
@@ -0,0 +1,35 @@
+import numpy
+
+from play3d.matrix import Matrix
+
+
+def test_matrix_eq():
+
+    assert (Matrix([[1, 3], [4, 5]]).matrix == numpy.array([
+        [1, 3],
+        [4, 5]
+    ])).all()
+
+
+def test_identity_matrix():
+    assert Matrix.identity_matrix() == Matrix([
+        [1, 0, 0, 0],
+        [0, 1, 0, 0],
+        [0, 0, 1, 0],
+        [0, 0, 0, 1]
+    ])
+
+
+def test_matrix_multiply():
+
+    a = Matrix([[2, 2],
+             [3, 4]])
+    b = Matrix([[4, 2],
+             [5, 2]])
+
+    result = a @ b
+
+    assert result == Matrix([
+     [18, 8],
+     [32, 14]
+    ])
diff --git a/tests/test_three_d.py b/tests/test_three_d.py
@@ -0,0 +1,31 @@
+import pytest
+
+from play3d.matrix import Matrix
+from play3d.models import Cube
+from play3d.three_d import translate
+
+
+class TestModelMatrix:
+
+    @pytest.mark.parametrize("position, scale",
+                             [((1, 2, 3), 1.9),
+                              ((5, 2, 3), 1),
+                              ])
+    def test_model_matrix(self, position, scale):
+        cube = Cube(position=position, scale=scale)
+        assert cube.matrix == Matrix([
+            [1 * scale, 0, 0, 0],
+            [0, 1 * scale, 0, 0],
+            [0, 0, 1 * scale, 0],
+            [*position, 1]
+        ])
+
+
+def test_model_position(cube):
+
+    assert list(cube.position()) == [0, 0, 0, 1]
+
+
+def test_model_translate(cube):
+    cube @ translate(1, 2, 3)
+    assert list(cube.position()) == [1.0, 2.0, 3.0, 1]
