tinyecs 0.3.2__tar.gz → 0.3.3__tar.gz

tinyecs-0.3.3/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: tinyecs
+Version: 0.3.3
+Summary: The teeniest, tiniest ECS system
+Author-email: Michael Lamertz <michael.lamertz@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/dickerdackel/tinyecs
+Project-URL: bugtracker, https://github.com/DickerDackel/tinyecs/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries :: pygame
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pgcooldown
+Dynamic: license-file
+
+# tinyecs - The teeniest, tiniest ECS for python
+
+ECS stands for Entity Component System, and it is a programming paradigm that
+differs from the well known OO.
+
+During my research I stumbled over
+
+[this article](https://web.archive.org/web/20250408195932/https://t-machine.org/index.php/2007/09/03/entity-systems-are-the-future-of-mmog-development-part-1/)
+
+and after reading part 2 and 3, I decided to implement an ECS myself, well
+aware that `esper` is a solid and long existing implementation, but I wanted
+to see how to implement it myself.
+
+I'm not trying to sell you an ECS by explaining the problems of multiple
+inheritance in game programming.  There are articles out there that do this in
+much detail.  If you're here, you're already interested in the concept, so
+the tutorial might be a good starting point.  It will create a small demo with
+bouncing sprites using pygame-ce.  But tinyecs is platform agnostic, you can
+use it with whatever library you like.
+
+
+## Installation
+
+tinyecs is available on pip and can be installed by::
+
+    pip install tinyecs
+
+The project is maintained and hosted on github at
+https://github.com/dickerdackel/tinyecs, where you also can find the wheels
+for a local install, or install it directly from the cloned repo.
+
+```console
+git clone https://github.com/dickerdackel/tinyecs
+cd tinyecs
+python3 -m venv --prompt tinyecs .venv
+.venv/bin/activate
+# or .venv/Scripts/activate.bat on windows
+pip install .
+```
+
+## Support / Contributing
+
+Issues can be opened on `Github`_
+
+.. _Github: https://github.com/dickerdackel/tinyecs/issues
+
+Please respect, that I don't want any contributions done with the assistance
+of AI.  This is a hobby project with focus on the craft of programming.  I
+have experimentally used AI to audit parts of the code and documentation, and
+while it found a lot of typos and 2 actual issues, without exception, the
+provided solutions were often besides the point or plain wrong.
+
+I have no possibility to enforce that request, the simple fact that I ask for
+it should be sufficient.
+
+## License
+
+This software is provided under the MIT license.
+
+See LICENSE file for details.

tinyecs-0.3.3/README.md

@@ -0,0 +1,60 @@
+# tinyecs - The teeniest, tiniest ECS for python
+
+ECS stands for Entity Component System, and it is a programming paradigm that
+differs from the well known OO.
+
+During my research I stumbled over
+
+[this article](https://web.archive.org/web/20250408195932/https://t-machine.org/index.php/2007/09/03/entity-systems-are-the-future-of-mmog-development-part-1/)
+
+and after reading part 2 and 3, I decided to implement an ECS myself, well
+aware that `esper` is a solid and long existing implementation, but I wanted
+to see how to implement it myself.
+
+I'm not trying to sell you an ECS by explaining the problems of multiple
+inheritance in game programming.  There are articles out there that do this in
+much detail.  If you're here, you're already interested in the concept, so
+the tutorial might be a good starting point.  It will create a small demo with
+bouncing sprites using pygame-ce.  But tinyecs is platform agnostic, you can
+use it with whatever library you like.
+
+
+## Installation
+
+tinyecs is available on pip and can be installed by::
+
+    pip install tinyecs
+
+The project is maintained and hosted on github at
+https://github.com/dickerdackel/tinyecs, where you also can find the wheels
+for a local install, or install it directly from the cloned repo.
+
+```console
+git clone https://github.com/dickerdackel/tinyecs
+cd tinyecs
+python3 -m venv --prompt tinyecs .venv
+.venv/bin/activate
+# or .venv/Scripts/activate.bat on windows
+pip install .
+```
+
+## Support / Contributing
+
+Issues can be opened on `Github`_
+
+.. _Github: https://github.com/dickerdackel/tinyecs/issues
+
+Please respect, that I don't want any contributions done with the assistance
+of AI.  This is a hobby project with focus on the craft of programming.  I
+have experimentally used AI to audit parts of the code and documentation, and
+while it found a lot of typos and 2 actual issues, without exception, the
+provided solutions were often besides the point or plain wrong.
+
+I have no possibility to enforce that request, the simple fact that I ask for
+it should be sufficient.
+
+## License
+
+This software is provided under the MIT license.
+
+See LICENSE file for details.

tinyecs-0.3.3/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = ../build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

tinyecs-0.3.3/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=../build
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

tinyecs-0.3.3/docs/source/api.rst

@@ -0,0 +1,71 @@
+tinyecs API
+===========
+
+.. contents::
+   :class: this-will-duplicate-information-and-it-is-still-useful-here
+
+Primary functions
+-----------------
+
+.. autofunction:: tinyecs.create_entity
+.. autofunction:: tinyecs.add_component
+.. autofunction:: tinyecs.add_components
+.. autofunction:: tinyecs.remove_component
+.. autofunction:: tinyecs.run_system
+
+Requesting components
+---------------------
+
+.. autofunction:: tinyecs.comp_of_eid
+.. autofunction:: tinyecs.comps_of_eid
+.. autofunction:: tinyecs.eid_has
+
+ECS Management
+--------------
+
+.. autofunction:: tinyecs.reset
+
+Running systems in bulk
+-----------------------
+
+.. autofunction:: tinyecs.add_system
+.. autofunction:: tinyecs.remove_system
+.. autofunction:: tinyecs.run_all_systems
+
+.. autofunction:: tinyecs.add_system_to_domain
+.. autofunction:: tinyecs.remove_system_from_domain
+.. autofunction:: tinyecs.run_domain
+
+Other helpers
+-------------
+
+.. autofunction:: tinyecs.cid_of_comp
+.. autofunction:: tinyecs.cids_of_eid
+.. autofunction:: tinyecs.eid_of_comp
+.. autofunction:: tinyecs.eids_by_cids
+.. autofunction:: tinyecs.has
+.. autofunction:: tinyecs.healthcheck
+
+Archetypes
+----------
+
+.. autofunction:: tinyecs.create_archetype
+.. autofunction:: tinyecs.add_to_archetype
+.. autofunction:: tinyecs.comps_of_archetype
+.. autofunction:: tinyecs.remove_archetype
+.. autofunction:: tinyecs.remove_from_archetype
+
+Properties
+----------
+.. autofunction:: tinyecs.set_property
+.. autofunction:: tinyecs.set_properties
+.. autofunction:: tinyecs.remove_property
+.. autofunction:: tinyecs.has_property
+.. autofunction:: tinyecs.clear_properties
+.. autofunction:: tinyecs.eids_by_property
+.. autofunction:: tinyecs.purge_by_property
+
+.. .. automodule:: tinyecs
+..    :members:
+..    :undoc-members:
+..    :show-inheritance:

tinyecs-0.3.3/docs/source/conf.py

@@ -0,0 +1,51 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../../src'))
+
+project = 'tinyecs'
+copyright = '2026, Michael "Dicker Dackel" Lamertz'
+author = 'Michael "Dicker Dackel" Lamertz'
+release = '0.3.3'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+    'myst_parser',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'furo'
+html_static_path = ['_static']
+html_theme_options = {
+    "navigation_with_keys": True,
+    "source_repository": "https://github.com/dickerdackel/tinyecs",
+    "source_branch": "main",
+    "source_directory": "docs/",
+    "dark_css_variables": {
+        "color-api-pre-name": "orange",
+        "color-api-name": "orange",
+    }
+}
+

tinyecs-0.3.3/docs/source/index.rst

@@ -0,0 +1,14 @@
+tinyecs - The teeniest, tiniest python ECS
+###########################################
+
+.. toctree::
+   :caption: Contents:
+
+   introduction
+   tutorial
+   api
+
+Indices
+=======
+
+* :ref:`genindex`

tinyecs-0.3.3/docs/source/introduction.rst

@@ -0,0 +1,63 @@
+Introduction
+############
+
+ECS stands for Entity Component System, and it is a programming paradigm that
+differs from the well known OO.
+
+During my research I stumbled over `this article`_ and after reading part 2 and
+3, I decided to implement an ECS myself, well aware that `esper` is a solid
+and long existing implementation, but I wanted to see how to implement it
+myself.
+
+.. _this article: https://web.archive.org/web/20250408195932/https://t-machine.org/index.php/2007/09/03/entity-systems-are-the-future-of-mmog-development-part-1/
+
+
+I'm not trying to sell you an ECS by explaining the problems of multiple
+inheritance in game programming.  There are articles out there that do this in
+much detail.  If you're here, you're already interested in the concept, so
+the tutorial might be a good starting point.  It will create a small demo with
+bouncing sprites using pygame-ce.  But tinyecs is platform agnostic, you can
+use it with whatever library you like.
+
+
+Installation
+============
+
+tinyecs is available on pip and can be installed by::
+
+    pip install tinyecs
+
+The project is maintained and hosted on `github`_, where you also can find the
+wheels for a local install, or install it directly from the cloned repo.
+
+.. _github: https://github.com/dickerdackel/tinyecs
+
+    git clone https://github.com/dickerdackel/tinyecs
+    cd tinyecs
+    python3 -m venv --prompt tinyecs .venv
+    .venv/bin/activate
+    # or .venv/Scripts/activate.bat on windows
+    pip install .
+
+Support / Contributing
+======================
+
+Issues can be opened on `Github`_
+
+.. _Github: https://github.com/dickerdackel/tinyecs/issues
+
+Please respect, that I don't want any contributions done with the assistance
+of AI.  This is a hobby project with focus on the craft of programming.  I
+have experimentally used AI to audit parts of the code and documentation, and
+while it found a lot of typos and 2 actual issues, without exception, the
+provided solutions were often besides the point or plain wrong.
+
+I have no possibility to enforce that request, the simple fact that I ask for
+it should be sufficient.
+
+License
+=======
+
+This software is provided under the MIT license.
+
+See LICENSE file for details.