Merge pull request #26 from Beefy-Swain/rf/caster

JSON Re-Write

Author: Cleptomania

.gitignore

@@ -103,3 +103,6 @@ venv.bak/
 # mypy
 .mypy_cache/
 .idea/
+
+# VS Code Directory
+.vscode

.pylintrc

@@ -305,7 +305,8 @@ good-names=i,
            y,
            ex,
            Run,
-           _
+           _,
+           id
 
 # Include a hint for the correct naming format with invalid-name.
 include-naming-hint=no

README.md

@@ -1,16 +1,15 @@
 # PyTiled Parser
 
-PyTiled Parser is a Python Library for parsing 
-[Tiled Map Editor](https://www.mapeditor.org/) (`.tmx`) files used to generate 
-maps and levels for 2D top-down or side-scrolling games.
+PyTiled Parser is a Python Library for parsing JSON formatted
+[Tiled Map Editor](https://www.mapeditor.org/) maps and tilesets to be used as maps and levels for 2D top-down (orthogonal, hexogonal, or isometric) or side-scrolling games in a strictly typed fashion.
 
 PyTiled Parser is not tied to any particular graphics library, and can be used
 with [Arcade](http://arcade.academy), 
 [Pyglet](https://pyglet.readthedocs.io/en/pyglet-1.3-maintenance/), 
 [Pygame](https://www.pygame.org/news), etc. 
 
 * Documentation available at: https://pytiled-parser.readthedocs.io/
-* GitHub project at: https://github.com/pvcraven/pytiled_parser
+* GitHub project at: https://github.com/Beefy-Swain/pytiled_parser
 * PiPy: https://pypi.org/project/pytiled-parser/
 
 The [Arcade](http://arcade.academy) library has 
@@ -19,4 +18,10 @@ integrate PyTiled with that 2D libary, and
 [example code](http://arcade.academy/examples/index.html#tmx-files-tiled-map-editor) showing its use.
 
 Original module by [Beefy-Swain](https://github.com/Beefy-Swain). 
-Contributions from [pvcraven](https://github.com/pvcraven).
+Significant contributions from [pvcraven](https://github.com/pvcraven) and [Cleptomania](https://github.com/Cleptomania).
+
+## Developement
+To develop pytiled parser, clone the repo, create a `venv` using a supported Python version, and activate it. Then install the package as well as all testing dependencies with the command `python -m pip install -e ".[tests]"`.
+
+### Testing
+Run `pytest --cov=pytiled_parser` to run the test harness and report coverage.

dev_requirements.txt

@@ -1,35 +1,35 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=source
-set BUILDDIR=build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/make.bat

@@ -1,23 +1,59 @@
-.. _pytiled-api:
-
 PyTiled Parser API
 ==================
 
-This page documents the Application Programming Interface (API)
-for the PyTiled Parser library.
+pytiled\_parser.common\_types
+------------------------------------
+
+.. automodule:: pytiled_parser.common_types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pytiled\_parser.layer
+----------------------------
+
+.. automodule:: pytiled_parser.layer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pytiled\_parser.properties
+---------------------------------
+
+.. automodule:: pytiled_parser.properties
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+pytiled\_parser.tiled\_map
+---------------------------------
+
+.. automodule:: pytiled_parser.tiled_map
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pytiled\_parser.tiled\_object
+------------------------------------
+
+.. automodule:: pytiled_parser.tiled_object
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-.. automodule:: pytiled_parser.xml_parser
-    :members:
-    :undoc-members:
-    :show-inheritance:
+pytiled\_parser.tileset
+------------------------------
 
-.. automodule:: pytiled_parser.objects
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. automodule:: pytiled_parser.tileset
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-.. automodule:: pytiled_parser.utilities
-    :members:
-    :undoc-members:
-    :show-inheritance:
+pytiled\_parser.util
+---------------------------
 
+.. automodule:: pytiled_parser.util
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/10_ladders_and_more.png

@@ -2,67 +2,63 @@
 #
 # This file only contains a selection of the most common options. For a full
 # list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
 
+sys.path.insert(0, os.path.abspath('../..'))
 
 # -- Project information -----------------------------------------------------
 
-import os
-import sys
+project = 'PyTiled Parser'
+copyright = '2021, Beefy-Swain, Cleptomania'
+author = 'Beefy-Swain, Cleptomania'
 
-project = "PyTiled Parser"
-copyright = "2019, Beefy-Swain"
-author = "Beefy-Swain"
+# The full version, including alpha/beta/rc tags
+release = '1.0.0'
 
-sys.path.insert(0, os.path.abspath("../.."))
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.intersphinx",
-    "sphinx.ext.todo",
-    "sphinx.ext.coverage",
-    "sphinx.ext.ifconfig",
-    "sphinx.ext.viewcode",
+    'sphinx.ext.autodoc',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-source_suffix = ".rst"
-
-master_doc = "index"
-
-pygments_style = "sphinx"
+templates_path = ['_templates']
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 
+source_suffix = '.rst'
+
+master_doc = 'index'
+
+pygments_style = 'sphinx'
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = 'sphinx_rtd_theme'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+html_static_path = ['_static']

docs/source/api.rst

@@ -1,36 +1,20 @@
 PyTiled Parser
 ==============
 
-.. image:: 10_ladders_and_more.png
-    :width: 50%
+PyTiled Parser is a Python library for parsing `Tiled Map Editor`_ (`.json`) files used to generate maps and levels for 2D games.
 
-PyTiled Parser is a Python Library for parsing
-`Tiled Map Editor`_ (`.tmx`) files used to generate
-maps and levels for 2D top-down or side-scrolling games.
+PyTiled Parser is not tied to any particular graphics library, and can be used with Arcade_, Pyglet_, Pygame_, and more.
 
-PyTiled Parser is not tied to any particular graphics library, and can be used
-with Arcade_, Pyglet_, Pygame_, and more.
-
-API Documentation
+API documentation
 -----------------
 
 .. toctree::
    :maxdepth: 2
 
    api
 
-Examples
---------
-
-* `Games using the Arcade library <http://arcade.academy/examples/index.html#tmx-files-tiled-map-editor>`_
-
-.. _Tiled Map Editor: https://www.mapeditor.org/
-.. _Arcade: http://arcade.academy
-.. _Pyglet: https://pyglet.readthedocs.io/en/pyglet-1.3-maintenance/
-.. _Pygame: https://www.pygame.org/news
-
 For More Info
 -------------
 
-* `PyTiled Parser on GitHub <https://github.com/pvcraven/pytiled_parser>`_
-* `PyTiled Parser on PyPi <https://pypi.org/project/pytiled-parser/>`_
+* `PyTiled Parser on Github <https://github.com/beefy-swain/pytiled_parser>`_
+* `PyTiled Parser on PyPi <https://pypi.org/project/pytiled-parser/>`_