tinyecs-compsys-base 0.0.1__tar.gz → 0.0.2__tar.gz

{tinyecs_compsys_base-0.0.1 → tinyecs_compsys_base-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinyecs-compsys-base
-Version: 0.0.1
+Version: 0.0.2
 Summary: Foundational component and system library for tinyecs
 Author-email: Michael Lamertz <michael.lamertz@gmail.com>
 License-Expression: MIT
@@ -15,36 +15,46 @@ License-File: LICENSE
 Requires-Dist: aenum
 Requires-Dist: pgcooldown
 Requires-Dist: tinyecs>=0.5.0
+Requires-Dist: tinyecs-compsys
+Requires-Dist: tinyecs-compsys-base
 Dynamic: license-file
 
 tinyecs-compsys-base
 ====================
 
-Thise are some very basic and framework independent components.
+These are some very basic and framework independent components.
+
+``tinyecs.compsys.base`` provides a set of components and systems that are
+independent from any graphics framework or backend.  These components and
+systems are mostly about entity management.  See the API docs for a list.
 
 Synopsis
 --------
 
-.. code:: python
+While this package can be imported directly, the more flexible approach is to
+have ``tinyecs.compsys`` find it and import it with all other ``compsys``
+packages under a common namespace.
 
-   from tinyecs.compsys.base import ...
+.. code:: python
 
-Usage
------
+   import tinyecs.compsys as cs
 
-This package has no direct functionality, but all sub modules will register
-their component IDs in the ``tinyecs.compsys.Comp`` enum.
+   cs.register()
 
 Installation
 ------------
 
-Installation instructions + requirements (should come automagically with
-pyproject.toml)
+It's up to you, if you install the currently provided `compsys` packages from
+`tinyecs` by using
 
 .. code:: console
 
    pip install tinyecs[base]
-   # or
+
+or include them by adding specific dependencies:
+
+.. code:: console
+
    pip install tinyecs
    pip install tinyecs-compsys
    pip install tinyecs-compsys-base
@@ -54,7 +64,7 @@ Support / Contributing
 
 Issues can be opened on `github issues`_
 
-.. _github issues: https://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys/issues
+.. _github issues: https://github.com/dickerdackel/tinyecs-compsys-base/issues
 
 
 License

tinyecs_compsys_base-0.0.2/README.rst

@@ -0,0 +1,54 @@
+tinyecs-compsys-base
+====================
+
+These are some very basic and framework independent components.
+
+``tinyecs.compsys.base`` provides a set of components and systems that are
+independent from any graphics framework or backend.  These components and
+systems are mostly about entity management.  See the API docs for a list.
+
+Synopsis
+--------
+
+While this package can be imported directly, the more flexible approach is to
+have ``tinyecs.compsys`` find it and import it with all other ``compsys``
+packages under a common namespace.
+
+.. code:: python
+
+   import tinyecs.compsys as cs
+
+   cs.register()
+
+Installation
+------------
+
+It's up to you, if you install the currently provided `compsys` packages from
+`tinyecs` by using
+
+.. code:: console
+
+   pip install tinyecs[base]
+
+or include them by adding specific dependencies:
+
+.. code:: console
+
+   pip install tinyecs
+   pip install tinyecs-compsys
+   pip install tinyecs-compsys-base
+
+Support / Contributing
+----------------------
+
+Issues can be opened on `github issues`_
+
+.. _github issues: https://github.com/dickerdackel/tinyecs-compsys-base/issues
+
+
+License
+-------
+
+This software is provided under the MIT license.
+
+See LICENSE file for details.

{tinyecs_compsys_base-0.0.1 → tinyecs_compsys_base-0.0.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "tinyecs-compsys-base"
 description = "Foundational component and system library for tinyecs"
-version = "0.0.1"
+version = "0.0.2"
 readme = "README.rst"
 
 authors = [
@@ -22,6 +22,8 @@ dependencies = [
     'aenum',
     'pgcooldown',
     'tinyecs >= 0.5.0',
+    'tinyecs-compsys',
+    'tinyecs-compsys-base',
 ]
 
 [project.urls]

{tinyecs_compsys_base-0.0.1 → tinyecs_compsys_base-0.0.2}/src/tinyecs/compsys/base/__init__.py

@@ -13,6 +13,7 @@ extend_enum(Comp, 'CROND')
 extend_enum(Comp, 'FOLLOWUP')
 extend_enum(Comp, 'IS_KILLED')
 extend_enum(Comp, 'KILL_WITH_PARENT')
+extend_enum(Comp, 'LIFETIME')
 extend_enum(Comp, 'TIMER')
 
 
@@ -20,20 +21,21 @@ extend_enum(Comp, 'TIMER')
 class Timer:
     """An optionally repeating timer component.
 
-    :param cooldown: The actual timer object
+    :param cooldown: Either a pgcooldown.Cooldown object or a number of seconds
     :param callback: The function to run when the timer fires
     :param repeat: Decides if the timer is reoccurring
 
     The prototype of the callback function is::
 
-        def callback()
+        def callback() -> None:
+            ...
 
     .. note:: If ``repeat`` is false, when using :func:`sys_timer`, the
         component will be removed after it fired.
     """
 
     cooldown: InitVar[float | Cooldown]
-    callback: Callable[None, []]
+    callback: Callable[[], None]
     repeat: bool = False
 
     def __post_init__(self, cooldown: Cooldown | float) -> None:
@@ -54,18 +56,20 @@ def sys_crond(eid: EntityID, crond: CronD) -> None:
     crond.update()
 
 
-def sys_followup(eid: EntityID, is_killed: bool, followup: Callable[[], None]) -> None:
+def sys_followup(eid: EntityID, is_killed: bool, followup: Callable[[EntityID], None]) -> None:
     """Run a followup function after an entity is marked as dead.
 
     :param eid: The entity ID
-    :param is_killed: The boolean flag component to mark this as killed
+    :param is_killed: The marker component that indicates that this entity is killed
+        The existence of this component alone is sufficient, its value is ignored
     :param followup: A callback to run
 
     The prototype for the callback is::
 
-        def callback() -> None
+        def callback(eid: EntityID) -> None:
+            ...
 
-    Once the followup has fired, its component is removed.
+    The followup component is removed before the callback is called.
     """
 
     ecs.remove_component(eid, Comp.FOLLOWUP)
@@ -73,7 +77,7 @@ def sys_followup(eid: EntityID, is_killed: bool, followup: Callable[[], None]) -
 
 
 def sys_kill_with_parent(eid: EntityID, parent: EntityID):
-    """Mark this entity as "killed" if its parent is killed as well.
+    """Mark this entity as "killed" if its parent is marked as killed as well.
 
     :param eid: The entity ID
     :param parent: The parent entity to watch
@@ -86,7 +90,7 @@ def sys_kill_with_parent(eid: EntityID, parent: EntityID):
 
 
 def sys_lifetime(eid: EntityID, lifetime: Cooldown) -> None:
-    """Update position based on a LerpPosition object.
+    """Mark the entity as killed if its lifetime has run out.
 
     :param eid: The entity ID
     :param lifetime: A `pgcooldown.Cooldown` instance
@@ -102,14 +106,15 @@ def sys_reap(eid: EntityID, is_killed: bool) -> None:
     """Remove entities that have a Comp.IS_KILLED component.
 
     :param eid: The entity ID
-    :param is_killed: Exactly that
+    :param is_killed: The marker component that indicates that this entity is killed
+        The existence of this component alone is sufficient, its value is ignored
 
     """
 
     ecs.remove_entity(eid)
 
 
-def sys_timer(eid: EntityID, timer: Cooldown) -> None:
+def sys_timer(eid: EntityID, timer: Timer) -> None:
     """Run a callback function after a timer runs out.
 
     :param eid: The entity ID
@@ -120,7 +125,9 @@ def sys_timer(eid: EntityID, timer: Cooldown) -> None:
 
     The prototype for the callback is::
 
-        def callback() -> None
+        def callback() -> None:
+            ...
+
     """
 
     if timer.cooldown.cold():

{tinyecs_compsys_base-0.0.1 → tinyecs_compsys_base-0.0.2}/src/tinyecs_compsys_base.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinyecs-compsys-base
-Version: 0.0.1
+Version: 0.0.2
 Summary: Foundational component and system library for tinyecs
 Author-email: Michael Lamertz <michael.lamertz@gmail.com>
 License-Expression: MIT
@@ -15,36 +15,46 @@ License-File: LICENSE
 Requires-Dist: aenum
 Requires-Dist: pgcooldown
 Requires-Dist: tinyecs>=0.5.0
+Requires-Dist: tinyecs-compsys
+Requires-Dist: tinyecs-compsys-base
 Dynamic: license-file
 
 tinyecs-compsys-base
 ====================
 
-Thise are some very basic and framework independent components.
+These are some very basic and framework independent components.
+
+``tinyecs.compsys.base`` provides a set of components and systems that are
+independent from any graphics framework or backend.  These components and
+systems are mostly about entity management.  See the API docs for a list.
 
 Synopsis
 --------
 
-.. code:: python
+While this package can be imported directly, the more flexible approach is to
+have ``tinyecs.compsys`` find it and import it with all other ``compsys``
+packages under a common namespace.
 
-   from tinyecs.compsys.base import ...
+.. code:: python
 
-Usage
------
+   import tinyecs.compsys as cs
 
-This package has no direct functionality, but all sub modules will register
-their component IDs in the ``tinyecs.compsys.Comp`` enum.
+   cs.register()
 
 Installation
 ------------
 
-Installation instructions + requirements (should come automagically with
-pyproject.toml)
+It's up to you, if you install the currently provided `compsys` packages from
+`tinyecs` by using
 
 .. code:: console
 
    pip install tinyecs[base]
-   # or
+
+or include them by adding specific dependencies:
+
+.. code:: console
+
    pip install tinyecs
    pip install tinyecs-compsys
    pip install tinyecs-compsys-base
@@ -54,7 +64,7 @@ Support / Contributing
 
 Issues can be opened on `github issues`_
 
-.. _github issues: https://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys/issues
+.. _github issues: https://github.com/dickerdackel/tinyecs-compsys-base/issues
 
 
 License

{tinyecs_compsys_base-0.0.1 → tinyecs_compsys_base-0.0.2}/src/tinyecs_compsys_base.egg-info/SOURCES.txt

@@ -7,5 +7,4 @@ src/tinyecs_compsys_base.egg-info/PKG-INFO
 src/tinyecs_compsys_base.egg-info/SOURCES.txt
 src/tinyecs_compsys_base.egg-info/dependency_links.txt
 src/tinyecs_compsys_base.egg-info/requires.txt
-src/tinyecs_compsys_base.egg-info/top_level.txt
-tests/test_FIXME.py
+src/tinyecs_compsys_base.egg-info/top_level.txt

tinyecs_compsys_base-0.0.2/src/tinyecs_compsys_base.egg-info/requires.txt

@@ -0,0 +1,5 @@
+aenum
+pgcooldown
+tinyecs>=0.5.0
+tinyecs-compsys
+tinyecs-compsys-base

tinyecs_compsys_base-0.0.1/README.rst

@@ -1,46 +0,0 @@
-tinyecs-compsys-base
-====================
-
-Thise are some very basic and framework independent components.
-
-Synopsis
---------
-
-.. code:: python
-
-   from tinyecs.compsys.base import ...
-
-Usage
------
-
-This package has no direct functionality, but all sub modules will register
-their component IDs in the ``tinyecs.compsys.Comp`` enum.
-
-Installation
-------------
-
-Installation instructions + requirements (should come automagically with
-pyproject.toml)
-
-.. code:: console
-
-   pip install tinyecs[base]
-   # or
-   pip install tinyecs
-   pip install tinyecs-compsys
-   pip install tinyecs-compsys-base
-
-Support / Contributing
-----------------------
-
-Issues can be opened on `github issues`_
-
-.. _github issues: https://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys/issues
-
-
-License
--------
-
-This software is provided under the MIT license.
-
-See LICENSE file for details.

tinyecs_compsys_base-0.0.1/src/tinyecs_compsys_base.egg-info/requires.txt

@@ -1,3 +0,0 @@
-aenum
-pgcooldown
-tinyecs>=0.5.0

tinyecs_compsys_base-0.0.1/tests/test_FIXME.py

@@ -1,12 +0,0 @@
-import pytest
-
-from contextlib import nullcontext as does_not_raise
-
-
-def test_FIXME():
-    assert True is True
-    ...
-
-    with pytest.raises(FIXME_ExpectedException_FIXME) as e:  # noqa
-        FIXME_function_expected_to_raise_exception()  # noqa
-    assert 'FIXME_string_expected_in_exception' in str(e.value)