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

tinyecs_compsys-0.0.2/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: tinyecs-compsys
+Version: 0.0.2
+Summary: Compsys namespace package for tinyecs
+Author-email: Michael Lamertz <michael.lamertz@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/dickerdackel/tinyecs-compsys
+Project-URL: bugtracker, https://github.com/dickerdackel/tinyecs-compsys/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries :: pygame
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: aenum
+Requires-Dist: tinyecs>=0.5.0
+Dynamic: license-file
+
+tinyecs-compsys
+===============
+
+This is the namespace to contain all other ``tinyecs-compsys-XXXX`` packages.
+
+Synopsis
+--------
+
+.. code:: python
+
+   import tinyecs.compsys as cs
+
+   cs.register()
+
+Usage
+-----
+
+This package provides the namespace and a starting point for all
+``tinyecs-compsys-<CATEGORY>`` packages.
+
+Importing this package and calling its ``register`` function will import all immediate
+subpackages and have those inject their component IDs into the ``Comp`` enum.
+
+.. note:: The ``Comp`` contains symbols to use as component IDs in
+   ``tinyecs``.  While every hashable is a valid component ID, and it's
+   completely fine to just use strings for small projects, using the provided
+   enum has the benefit of finding typing errors much easier.  It's
+   recommended to make use of that.
+
+   This package makes use of `aenum`, an advanced and extendable
+   implementation of python enums, written by the same author that also
+   maintains the official python version.
+
+   If you create your own components and systems, you can add those to
+   ``Comp`` as well::
+
+      from aenum import extend_enum
+
+      extend_enum(cs.Comp, 'YOUR_COMPONENT')
+      ...
+
+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/issues
+
+License
+-------
+
+This software is provided under the MIT license.
+
+See LICENSE file for details.

tinyecs_compsys-0.0.2/README.rst

@@ -0,0 +1,72 @@
+tinyecs-compsys
+===============
+
+This is the namespace to contain all other ``tinyecs-compsys-XXXX`` packages.
+
+Synopsis
+--------
+
+.. code:: python
+
+   import tinyecs.compsys as cs
+
+   cs.register()
+
+Usage
+-----
+
+This package provides the namespace and a starting point for all
+``tinyecs-compsys-<CATEGORY>`` packages.
+
+Importing this package and calling its ``register`` function will import all immediate
+subpackages and have those inject their component IDs into the ``Comp`` enum.
+
+.. note:: The ``Comp`` contains symbols to use as component IDs in
+   ``tinyecs``.  While every hashable is a valid component ID, and it's
+   completely fine to just use strings for small projects, using the provided
+   enum has the benefit of finding typing errors much easier.  It's
+   recommended to make use of that.
+
+   This package makes use of `aenum`, an advanced and extendable
+   implementation of python enums, written by the same author that also
+   maintains the official python version.
+
+   If you create your own components and systems, you can add those to
+   ``Comp`` as well::
+
+      from aenum import extend_enum
+
+      extend_enum(cs.Comp, 'YOUR_COMPONENT')
+      ...
+
+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/issues
+
+License
+-------
+
+This software is provided under the MIT license.
+
+See LICENSE file for details.

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

@@ -1,7 +1,7 @@
 [project]
 name = "tinyecs-compsys"
-description = "Compsys root for tinyecs"
-version = "0.0.1"
+description = "Compsys namespace package for tinyecs"
+version = "0.0.2"
 readme = "README.rst"
 
 authors = [
@@ -24,8 +24,8 @@ dependencies = [
 ]
 
 [project.urls]
-homepage = "https://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys"
-bugtracker = "https://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys/issues"
+homepage = "https://github.com/dickerdackel/tinyecs-compsys"
+bugtracker = "https://github.com/dickerdackel/tinyecs-compsys/issues"
 
 [build-system]
 requires = ["setuptools"]

tinyecs_compsys-0.0.2/src/tinyecs/compsys/__init__.py

@@ -0,0 +1,26 @@
+from importlib import import_module
+from pkgutil import iter_modules
+
+from aenum import StrEnum
+
+
+class Comp(StrEnum):
+    ...
+
+
+class Prop(StrEnum):
+    ...
+
+
+def register():
+    """Register all tinyecs-compsys subpackages.
+
+    Use this at the beginning of your project to import all immediate
+    subpackages into the ``tinyecs.compsys`` namespace. Registered packages
+    will inject their component IDs into ``tinyecs.compsys.Comp``.
+    """
+
+    for sub in iter_modules(__path__):
+        if sub.ispkg:
+            print(f'Importing {__name__}.{sub.name}')
+            import_module(f'{__name__}.{sub.name}')

tinyecs_compsys-0.0.2/src/tinyecs_compsys.egg-info/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: tinyecs-compsys
+Version: 0.0.2
+Summary: Compsys namespace package for tinyecs
+Author-email: Michael Lamertz <michael.lamertz@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/dickerdackel/tinyecs-compsys
+Project-URL: bugtracker, https://github.com/dickerdackel/tinyecs-compsys/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries :: pygame
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: aenum
+Requires-Dist: tinyecs>=0.5.0
+Dynamic: license-file
+
+tinyecs-compsys
+===============
+
+This is the namespace to contain all other ``tinyecs-compsys-XXXX`` packages.
+
+Synopsis
+--------
+
+.. code:: python
+
+   import tinyecs.compsys as cs
+
+   cs.register()
+
+Usage
+-----
+
+This package provides the namespace and a starting point for all
+``tinyecs-compsys-<CATEGORY>`` packages.
+
+Importing this package and calling its ``register`` function will import all immediate
+subpackages and have those inject their component IDs into the ``Comp`` enum.
+
+.. note:: The ``Comp`` contains symbols to use as component IDs in
+   ``tinyecs``.  While every hashable is a valid component ID, and it's
+   completely fine to just use strings for small projects, using the provided
+   enum has the benefit of finding typing errors much easier.  It's
+   recommended to make use of that.
+
+   This package makes use of `aenum`, an advanced and extendable
+   implementation of python enums, written by the same author that also
+   maintains the official python version.
+
+   If you create your own components and systems, you can add those to
+   ``Comp`` as well::
+
+      from aenum import extend_enum
+
+      extend_enum(cs.Comp, 'YOUR_COMPONENT')
+      ...
+
+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/issues
+
+License
+-------
+
+This software is provided under the MIT license.
+
+See LICENSE file for details.

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

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

tinyecs_compsys-0.0.1/PKG-INFO

@@ -1,68 +0,0 @@
-Metadata-Version: 2.4
-Name: tinyecs-compsys
-Version: 0.0.1
-Summary: Compsys root for tinyecs
-Author-email: Michael Lamertz <michael.lamertz@gmail.com>
-License-Expression: MIT
-Project-URL: homepage, https://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys
-Project-URL: bugtracker, https://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys/issues
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Games/Entertainment
-Classifier: Topic :: Software Development :: Libraries :: pygame
-Description-Content-Type: text/x-rst
-License-File: LICENSE
-Requires-Dist: aenum
-Requires-Dist: tinyecs>=0.5.0
-Dynamic: license-file
-
-tinyecs-compsys
-===============
-
-This is the namespace to contain all other ``tinyecs-compsys-XXXX`` packages.
-
-Synopsis
---------
-
-.. code:: python
-
-   import tinyecs.compsys as cs
-
-Usage
------
-
-Besides finding and registering sub modules, this package has no direct functionality.
-Calling the ``register`` function will import all submodules, which will in
-turn inject all their components into the ``Comp`` ``aenum``.
-
-Installation
-------------
-
-It's up to you, if you install the currently provided `compsys` packages from
-`tinyecs` by using
-
-.. code:: console
-
-   pip install tinyecs[all]
-
-or include them all 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://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys/issues
-
-License
--------
-
-This software is provided under the MIT license.
-
-See LICENSE file for details.

tinyecs_compsys-0.0.1/README.rst

@@ -1,50 +0,0 @@
-tinyecs-compsys
-===============
-
-This is the namespace to contain all other ``tinyecs-compsys-XXXX`` packages.
-
-Synopsis
---------
-
-.. code:: python
-
-   import tinyecs.compsys as cs
-
-Usage
------
-
-Besides finding and registering sub modules, this package has no direct functionality.
-Calling the ``register`` function will import all submodules, which will in
-turn inject all their components into the ``Comp`` ``aenum``.
-
-Installation
-------------
-
-It's up to you, if you install the currently provided `compsys` packages from
-`tinyecs` by using
-
-.. code:: console
-
-   pip install tinyecs[all]
-
-or include them all 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://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys/issues
-
-License
--------
-
-This software is provided under the MIT license.
-
-See LICENSE file for details.

tinyecs_compsys-0.0.1/src/tinyecs/compsys/__init__.py

@@ -1,27 +0,0 @@
-from importlib import import_module
-from importlib.resources import files
-
-from aenum import StrEnum, auto
-
-
-class Comp(StrEnum):
-    NONE = auto()
-
-
-class Prop(StrEnum):
-    NONE = auto()
-
-
-def register():
-    """Register all tinyecs-compsy submodules.
-
-    Use this at the beginning of your project to import all submodules into the ``tinyecs.compsys`` namespace.
-    Registered modules will inject their components into ``tinyecs.compsys.Comp``.
-    """
-
-    BLACKLIST = ['__pycache__', '__init__.py']
-    HOME = files()
-
-    for sub in [_.name for _ in HOME.iterdir() if _.name not in BLACKLIST]:
-        print(f'Importing {sub}')
-        import_module(f'{__name__}.{sub}')

tinyecs_compsys-0.0.1/src/tinyecs_compsys.egg-info/PKG-INFO

@@ -1,68 +0,0 @@
-Metadata-Version: 2.4
-Name: tinyecs-compsys
-Version: 0.0.1
-Summary: Compsys root for tinyecs
-Author-email: Michael Lamertz <michael.lamertz@gmail.com>
-License-Expression: MIT
-Project-URL: homepage, https://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys
-Project-URL: bugtracker, https://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys/issues
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Games/Entertainment
-Classifier: Topic :: Software Development :: Libraries :: pygame
-Description-Content-Type: text/x-rst
-License-File: LICENSE
-Requires-Dist: aenum
-Requires-Dist: tinyecs>=0.5.0
-Dynamic: license-file
-
-tinyecs-compsys
-===============
-
-This is the namespace to contain all other ``tinyecs-compsys-XXXX`` packages.
-
-Synopsis
---------
-
-.. code:: python
-
-   import tinyecs.compsys as cs
-
-Usage
------
-
-Besides finding and registering sub modules, this package has no direct functionality.
-Calling the ``register`` function will import all submodules, which will in
-turn inject all their components into the ``Comp`` ``aenum``.
-
-Installation
-------------
-
-It's up to you, if you install the currently provided `compsys` packages from
-`tinyecs` by using
-
-.. code:: console
-
-   pip install tinyecs[all]
-
-or include them all 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://forgejo.indieandmore.photography/dickerdackel/tinyecs-compsys/issues
-
-License
--------
-
-This software is provided under the MIT license.
-
-See LICENSE file for details.

tinyecs_compsys-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)