nodezator 1.5.4__tar.gz → 1.6.0rc1__tar.gz

{nodezator-1.5.4 → nodezator-1.6.0rc1}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: nodezator
-Version: 1.5.4
+Version: 1.6.0rc1
 Summary: A generalist Python node editor
 Author-email: Kennedy Richard <kennedy@kennedyrichard.com>
-License: Unlicense
+License-Expression: Unlicense
 Project-URL: Homepage, https://nodezator.com
 Project-URL: Source Code, https://github.com/IndieSmiths/nodezator
 Project-URL: Forum, https://github.com/IndieSmiths/nodezator/discussions
@@ -11,24 +11,26 @@ Project-URL: User Manual, https://manual.nodezator.com
 Project-URL: Bug Tracker, https://github.com/IndieSmiths/nodezator/issues
 Project-URL: Donate, https://indiesmiths.com/donate
 Keywords: gui,desktop,application,pygame,pygame-ce,graph,graphs,nodes,node,editor
-Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Topic :: Software Development
-Classifier: Topic :: Software Development :: Libraries :: pygame
+Classifier: Topic :: Artistic Software
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Desktop Environment
 Classifier: Topic :: Multimedia
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: pygame
 Classifier: Topic :: Software Development :: User Interfaces
 Classifier: Topic :: Software Development :: Code Generators
-Classifier: Topic :: Artistic Software
-Classifier: Topic :: Office/Business
-Classifier: Topic :: Scientific/Engineering
-Classifier: Intended Audience :: End Users/Desktop
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+License-File: UNLICENSE
 Requires-Dist: pygame-ce
 Requires-Dist: numpy
+Dynamic: license-file
 
 # Nodezator
 
@@ -64,7 +66,9 @@ main_callable = get_circle_area
 
 ![node image](https://nodezator.com/images/get_circle_area_node.png)
 
-You can store these functions/node definitions anywhere you want in your disk and once you launch Nodezator just provide the path so Nodezator can load them. The only requirement is that you organize these nodes definitions in separate files and store them in a folder (more about that further ahead in another section).
+You can store these functions/node definitions anywhere you want in your disk and once you launch Nodezator just provide the path so Nodezator can load them. The only requirement is that you organize these nodes definitions in separate files and store them in a folder. This small video (~2min) actually shows you how to define and load a node in **less than 60 seconds**:
+
+[![video: Defining and loading a node in less than 60 seconds](https://img.youtube.com/vi/cMfoaEs0fGY/hqdefault.jpg)](https://www.youtube.com/watch?v=cMfoaEs0fGY)
 
 You can actually turn **any** callable into a node very easily: classes, methods, etc. All callables available in the Python ecosystem can be turned into a node (even the ones defined in C, for instance).
 
@@ -100,15 +104,17 @@ Nodezator can already be used in production and supports a vast variety of workf
 After you finish reading this README file, you may also want to visit Nodezator's homepage: https://nodezator.com
 
 
+
 ## Features
 
 On top of making it very easy to define nodes, Nodezator comes packed full of useful features for both Python programmers and other professionals that (likely with the help of a fellow programmer) can setup a no-code/low-code workflow.
 
+
 ### Work effortlessly with other libraries
 
 As we said before, Nodezator allows you to convert callables from third-party libraries with minimal effort. Here are just a few screenshots showing the usage of Nodezator with different libraries.
 
-Here's is a simple graph showing Nodezator usage with the [Pillow](https://python-pillow.org/) library.
+Here's a simple graph showing Nodezator usage with the [Pillow](https://python-pillow.org/) library.
 
 ![Pillow demonstration](https://nodezator.com/images/nodezator_pillow_demo.png)
 
@@ -181,6 +187,39 @@ Users can even choose the detection graphics used. From the most serious and dis
 ![Socket detection using baseball elements and eyes](https://nodezator.com/images/socket_detection_baseball_elements_and_eyes.gif)
 
 
+### Ziplining navigation
+
+With the ziplining feature users can **shift-click** a connection in order to be transported to the previous or next node instantly. This can be used to traverse the graph back and forth.
+
+![Browsing the graph with the ziplining feature](https://nodezator.com/images/ziplining_navigation.gif)
+
+People often need to inspect the path followed by data through connections between nodes to make sense of a graph. But sometimes such connections are very long, extending beyond the screen.
+
+Since we know we want to visit the next connected node regardless of its location, why spend time scrolling the screen? That's why ziplining exists.
+
+
+### Bird's eye view
+
+Another useful usability measure to help traverse the graph, the bird's eye view shows a semitransparent miniature version of the whole graph overlaid on the screen, allowing users to jump to any specific spot on the graph by clicking the corresponding spot on the miniature.
+
+![Bird's eye view](https://nodezator.com/images/birds_eye_view.png)
+
+In fact, you can hover the miniature with the mouse button pressed to traverse the entire graph continuously.
+
+
+### Language/locale support and community/users translation
+
+Nodezator fully supports English (en-us) and is on its way to reach complete coverage of Brazilian Portuguese (pt-br) and Simplified Chinese (zh-cn).
+
+Our translations depend on contributions from the community/users via pull requests. Please, check the **TRANSLATIONS.md** document at the top of the repository to learn how to contribute. Also, please, don't submit software translations of any kind, only manual translations.
+
+You can find whether your language/locale is available on the **Edit > Language and fonts** menu, where you can also choose another font for the interface if needed for your language/locale, either from your disk or from among the system fonts (the ones listed automatically by the [underlying backend tool](https://pyga.me/docs/ref/font.html#pygame.font.get_fonts) used).
+
+![Picking locale and font](https://nodezator.com/images/picking_locale_and_font.gif)
+
+Is your language/locale missing? Please, consider helping translate.
+
+
 ### Additional Python-related tools
 
 Being a node-based representation of Python, Nodezator includes a few extra features that help you access Python features in a node-based interface.
@@ -246,6 +285,8 @@ However, users are encouraged to define their own nodes for their specific purpo
 
 ![A user-defined node](https://nodezator.com/images/node.png)
 
+In case you missed it at the beginning of this README, here's the link to a small video demonstrating how to define and load a node in less than 60 seconds: https://www.youtube.com/watch?v=cMfoaEs0fGY
+
 Nodes are created from Python scripts organized within folders that we call **node packs**. You can create a node pack folder **anywhere you want in your disk**. Under the hood, Nodezator treats it as a package in some contexts, so you can name that folder whatever you like, as long as it is a Python identifier. That is, it must start with a letter or underscore and contain only letters, digits and underscores.
 
 In other words, you **create nodes by writing Python functions/callables using your preferred text editor or IDE** and only then you **launch Nodezator in order to load them as nodes**, so you can create, edit and execute graphs.
@@ -295,6 +336,9 @@ If you want to install it, just execute the command below. It will install nodez
 pip install --upgrade nodezator
 ```
 
+> [!IMPORTANT]
+> By default, the `pip` command above doesn't install pre-releases (alpha, beta, release candidate, etc.). If the version you want to install is a pre-release version, include the `--pre` option: `pip install --upgrade --pre nodezator`. An alternative is to simply specify the desired version: for instance, if you want `1.6.0rc1`, just execute `pip install nodezator==1.6.0rc1`.
+
 If everything goes well, after installing you should be able to launch the app by typing `nodezator` or `python -m nodezator` in your command line (or `python3 -m nodezator` depending on you system).
 
 
@@ -428,6 +472,18 @@ Other parts of the code, however, specially the most recent ones, are not so ref
 Also, other parts of the code, despite being carefully designed, might be redesigned in the future, since now that the app is published, it should evolve as we find problems and contribute to improve the app. In other words, some of the design may change in the future, so bear in mind that the software is still evolving.
 
 
+## Sibling projects
+
+The creator/maintainer of Nodezator (Kennedy) created and maintains other open-source projects as well. Because he has to split his time between them, it often takes a few months (sometimes more) for new work to be done in some of them. Even so, they are all active projects that he intends to complete.
+
+One of them is [Bionic Blue](https://github.com/IndieSmiths/bionicblue), an action platformer game made with the pygame-ce library. The first fully playable mission is already available. Here's a brief GIF showing the first few seconds of the mission:
+
+<p align="center">
+<a href="https://github.com/IndieSmiths/bionicblue"><img alt="Bionic Blue game screenshot" src="https://i.imgur.com/L9J1poV.gif" /></a>
+</p>
+
+
+
 [Kennedy Richard Silva Guerra]: https://kennedyrichard.com
 [PyPI]: https://pypi.org
 [numpy.save()]: https://numpy.org/doc/stable/reference/generated/numpy.save.html

{nodezator-1.5.4 → nodezator-1.6.0rc1}/README.md

@@ -32,7 +32,9 @@ main_callable = get_circle_area
 
 ![node image](https://nodezator.com/images/get_circle_area_node.png)
 
-You can store these functions/node definitions anywhere you want in your disk and once you launch Nodezator just provide the path so Nodezator can load them. The only requirement is that you organize these nodes definitions in separate files and store them in a folder (more about that further ahead in another section).
+You can store these functions/node definitions anywhere you want in your disk and once you launch Nodezator just provide the path so Nodezator can load them. The only requirement is that you organize these nodes definitions in separate files and store them in a folder. This small video (~2min) actually shows you how to define and load a node in **less than 60 seconds**:
+
+[![video: Defining and loading a node in less than 60 seconds](https://img.youtube.com/vi/cMfoaEs0fGY/hqdefault.jpg)](https://www.youtube.com/watch?v=cMfoaEs0fGY)
 
 You can actually turn **any** callable into a node very easily: classes, methods, etc. All callables available in the Python ecosystem can be turned into a node (even the ones defined in C, for instance).
 
@@ -68,15 +70,17 @@ Nodezator can already be used in production and supports a vast variety of workf
 After you finish reading this README file, you may also want to visit Nodezator's homepage: https://nodezator.com
 
 
+
 ## Features
 
 On top of making it very easy to define nodes, Nodezator comes packed full of useful features for both Python programmers and other professionals that (likely with the help of a fellow programmer) can setup a no-code/low-code workflow.
 
+
 ### Work effortlessly with other libraries
 
 As we said before, Nodezator allows you to convert callables from third-party libraries with minimal effort. Here are just a few screenshots showing the usage of Nodezator with different libraries.
 
-Here's is a simple graph showing Nodezator usage with the [Pillow](https://python-pillow.org/) library.
+Here's a simple graph showing Nodezator usage with the [Pillow](https://python-pillow.org/) library.
 
 ![Pillow demonstration](https://nodezator.com/images/nodezator_pillow_demo.png)
 
@@ -149,6 +153,39 @@ Users can even choose the detection graphics used. From the most serious and dis
 ![Socket detection using baseball elements and eyes](https://nodezator.com/images/socket_detection_baseball_elements_and_eyes.gif)
 
 
+### Ziplining navigation
+
+With the ziplining feature users can **shift-click** a connection in order to be transported to the previous or next node instantly. This can be used to traverse the graph back and forth.
+
+![Browsing the graph with the ziplining feature](https://nodezator.com/images/ziplining_navigation.gif)
+
+People often need to inspect the path followed by data through connections between nodes to make sense of a graph. But sometimes such connections are very long, extending beyond the screen.
+
+Since we know we want to visit the next connected node regardless of its location, why spend time scrolling the screen? That's why ziplining exists.
+
+
+### Bird's eye view
+
+Another useful usability measure to help traverse the graph, the bird's eye view shows a semitransparent miniature version of the whole graph overlaid on the screen, allowing users to jump to any specific spot on the graph by clicking the corresponding spot on the miniature.
+
+![Bird's eye view](https://nodezator.com/images/birds_eye_view.png)
+
+In fact, you can hover the miniature with the mouse button pressed to traverse the entire graph continuously.
+
+
+### Language/locale support and community/users translation
+
+Nodezator fully supports English (en-us) and is on its way to reach complete coverage of Brazilian Portuguese (pt-br) and Simplified Chinese (zh-cn).
+
+Our translations depend on contributions from the community/users via pull requests. Please, check the **TRANSLATIONS.md** document at the top of the repository to learn how to contribute. Also, please, don't submit software translations of any kind, only manual translations.
+
+You can find whether your language/locale is available on the **Edit > Language and fonts** menu, where you can also choose another font for the interface if needed for your language/locale, either from your disk or from among the system fonts (the ones listed automatically by the [underlying backend tool](https://pyga.me/docs/ref/font.html#pygame.font.get_fonts) used).
+
+![Picking locale and font](https://nodezator.com/images/picking_locale_and_font.gif)
+
+Is your language/locale missing? Please, consider helping translate.
+
+
 ### Additional Python-related tools
 
 Being a node-based representation of Python, Nodezator includes a few extra features that help you access Python features in a node-based interface.
@@ -214,6 +251,8 @@ However, users are encouraged to define their own nodes for their specific purpo
 
 ![A user-defined node](https://nodezator.com/images/node.png)
 
+In case you missed it at the beginning of this README, here's the link to a small video demonstrating how to define and load a node in less than 60 seconds: https://www.youtube.com/watch?v=cMfoaEs0fGY
+
 Nodes are created from Python scripts organized within folders that we call **node packs**. You can create a node pack folder **anywhere you want in your disk**. Under the hood, Nodezator treats it as a package in some contexts, so you can name that folder whatever you like, as long as it is a Python identifier. That is, it must start with a letter or underscore and contain only letters, digits and underscores.
 
 In other words, you **create nodes by writing Python functions/callables using your preferred text editor or IDE** and only then you **launch Nodezator in order to load them as nodes**, so you can create, edit and execute graphs.
@@ -263,6 +302,9 @@ If you want to install it, just execute the command below. It will install nodez
 pip install --upgrade nodezator
 ```
 
+> [!IMPORTANT]
+> By default, the `pip` command above doesn't install pre-releases (alpha, beta, release candidate, etc.). If the version you want to install is a pre-release version, include the `--pre` option: `pip install --upgrade --pre nodezator`. An alternative is to simply specify the desired version: for instance, if you want `1.6.0rc1`, just execute `pip install nodezator==1.6.0rc1`.
+
 If everything goes well, after installing you should be able to launch the app by typing `nodezator` or `python -m nodezator` in your command line (or `python3 -m nodezator` depending on you system).
 
 
@@ -396,6 +438,18 @@ Other parts of the code, however, specially the most recent ones, are not so ref
 Also, other parts of the code, despite being carefully designed, might be redesigned in the future, since now that the app is published, it should evolve as we find problems and contribute to improve the app. In other words, some of the design may change in the future, so bear in mind that the software is still evolving.
 
 
+## Sibling projects
+
+The creator/maintainer of Nodezator (Kennedy) created and maintains other open-source projects as well. Because he has to split his time between them, it often takes a few months (sometimes more) for new work to be done in some of them. Even so, they are all active projects that he intends to complete.
+
+One of them is [Bionic Blue](https://github.com/IndieSmiths/bionicblue), an action platformer game made with the pygame-ce library. The first fully playable mission is already available. Here's a brief GIF showing the first few seconds of the mission:
+
+<p align="center">
+<a href="https://github.com/IndieSmiths/bionicblue"><img alt="Bionic Blue game screenshot" src="https://i.imgur.com/L9J1poV.gif" /></a>
+</p>
+
+
+
 [Kennedy Richard Silva Guerra]: https://kennedyrichard.com
 [PyPI]: https://pypi.org
 [numpy.save()]: https://numpy.org/doc/stable/reference/generated/numpy.save.html

nodezator-1.6.0rc1/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

nodezator-1.6.0rc1/nodezator/__init__.py

@@ -0,0 +1,7 @@
+"""Nodezator: A generalist Python node editor."""
+
+from .appinfo import APP_VERSION_STRING
+
+
+
+__version__ = APP_VERSION_STRING

{nodezator-1.5.4 → nodezator-1.6.0rc1}/nodezator/__main__.py

@@ -47,6 +47,18 @@ with StringIO() as _temp_stream:
 
         import pygame
 
+## make sure pygame-ce is initialized (after preinitializing
+## its mixer module)
+
+from pygame import init as init_pygame
+from pygame.mixer import pre_init as pre_init_mixer
+
+# pygame mixer pre-initialization
+pre_init_mixer(44100, -16, 2, 4096)
+
+# pygame initialization
+init_pygame()
+
 
 ### local imports
 

{nodezator-1.5.4 → nodezator-1.6.0rc1}/nodezator/appinfo.py

@@ -4,53 +4,46 @@
 from collections import namedtuple
 
 
-### application version;
-###
-### the release level can be...
-###
-### 'beta' : changes are being implemented or were
-###          just implemented, but not enough tests
-###          were performed yet;
-###
-### 'release_candidate' : can be released, should not
-###                       be used in production, though;
-###
-### 'stable' : can be used in production; bugs,
-###            if existent, are considered tolerable;
 
-AppVersion = namedtuple("AppVersion", "major minor micro release_level")
+### versioning
 
-APP_VERSION = AppVersion(1, 5, 4, "release_candidate")
+# release level meaning:
+#
+# '' (empty string) -> stable release
+# 'a1', 'a2', etc. -> alpha release
+# 'b1', 'b2', etc. -> beta release
+# 'rc1', 'rc2', etc. -> release candidate
 
-MINIMAL_VERSION_STRING = '.'.join(map(str, APP_VERSION[:3]))
+AppVersion = namedtuple('AppVersion', 'major minor micro release_level')
+
+APP_VERSION = AppVersion(1, 6, 0, 'rc1')
+
+APP_VERSION_STRING = '.'.join(map(str, APP_VERSION[:3])) + APP_VERSION[3]
 
 
 ### titles for the application
 
 TITLE = "Nodezator"
+ABBREVIATED_TITLE = "NDZ"
 
 ## used to name directories related to the app, like
 ## the config and log folders; it is important in
 ## case the title ever uses a name with characters not
 ## supported by any major operating system;
-APP_DIR_NAME = "nodezator"
 
+APP_DIR_NAME = "nodezator"
 ORG_DIR_NAME = 'IndieSmiths' # org name for pygame.system.get_pref_path
 
-ABBREVIATED_TITLE = "NDZ"
-
 
-## custom title formats;
+## custom title and other custom formats
 
+FULL_TITLE = f"{TITLE} {APP_VERSION_STRING}"
 
-FULL_TITLE = "{} {} ({})".format(
-    TITLE, ".".join(str(i) for i in APP_VERSION[:3]), APP_VERSION[3]
+FULL_TITLE_MINUS_RELEASE_LEVEL = (
+    f"{TITLE} {'.'.join(str(i) for i in APP_VERSION[:3])}"
 )
 
-NO_RELEASE_LEVEL_FULL_TITLE = "{} {}".format(
-    TITLE,
-    ".".join(str(i) for i in APP_VERSION[:3]),
-)
+
 
 ### other
 

{nodezator-1.5.4 → nodezator-1.6.0rc1}/nodezator/classes2d/collections.py

@@ -33,8 +33,14 @@ class Collection2D:
         super().__init__(*args, **kwargs)
         self._rects_man = RectsManager(self.get_all_rects)
 
+
     ### methods related to collision
 
+    ### XXX some of the methods below could be further improved with a bit
+    ### bit of refactoring; some could use better, more descriptive names
+    ### and some new more general ones could be written from existing ones
+    ### that could perhaps replace some of them
+
     def get_on_screen(self):
         """Return iterator with all objects on screen.
 
@@ -82,7 +88,7 @@ class Collection2D:
 
             yield [rect_id_to_obj[id(rect)] for rect in cluster]
 
-    ## method to update
+    ### method to update
 
     def call_update(self):
         """Call the update method on all objects.
@@ -94,7 +100,7 @@ class Collection2D:
         for obj in self:
             obj.update()
 
-    ## mouse related methods
+    ### mouse related methods
 
     def mouse_method_on_collision(self, method_name, event):
         """Invoke inner widget if it collides with mouse.
@@ -156,7 +162,12 @@ class Collection2D:
         "on_mouse_release",
     )
 
-    ## methods related to drawing
+    ### methods related to drawing
+
+    ### XXX some of the methods below could be further improved with a bit
+    ### bit of refactoring; some could use better, more descriptive names
+    ### and some new more general ones could be written from existing ones
+    ### that could perhaps replace some of them
 
     def draw(self):
         """Blit obj.image at obj.rect coordinates.
@@ -215,10 +226,14 @@ class Collection2D:
     def draw_relative(self, obj):
         """Draw objects relative to position of given one."""
         negative_topleft = -Vector2(obj.rect.topleft)
+        blit_operation = obj.image.blit
 
         for current_obj in self:
 
-            obj.image.blit(current_obj.image, current_obj.rect.move(negative_topleft))
+            blit_operation(
+                current_obj.image,
+                current_obj.rect.move(negative_topleft),
+            )
 
     def call_draw(self):
         """Call the draw method on all objects."""