update docs

Author: shakfu

CHANGELOG.md

@@ -23,7 +23,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 - Added additional cmake build options with corresponding make targets
 
-- Added the `pktpy2` external, based on v2.0.5 of the [pocketpy](https://pocketpy.dev) python3.x interpreter, which aims to be an alternative to [Lua](https://lua.org) for game scripting. Development is ongoing.
+- Added the `pktpy2` external, based on `v2.0.5` of the [pocketpy](https://pocketpy.dev) python3.x interpreter, which aims to be an alternative to [Lua](https://lua.org) for game scripting. Development is ongoing.
 
 - Added [Python3-Externals-for-Max-MSP.pdf](https://github.com/shakfu/py-js/tree/main/source/docs/_book/Python3-Externals-for-Max-MSP.pdf) pdf book to the repository.
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2024 Shakeeb Alireza
+Copyright (c) 2025 Shakeeb Alireza
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -72,7 +72,7 @@ Note: networking (zmq-based) externals are not enabled by default since they req
 [jmx]: https://github.com/shakfu/py-js/tree/main/source/projects/jmx
 [zthread]: https://github.com/shakfu/py-js/tree/main/source/projects/zthread
 
-The common objective in these externals is to help use and distribute python code and libraries in Max applications. Many can be considered experimental, with 80% of development time going to the first two externals (`py` and `pyjs`). Please see below for an overview and feature comparison.
+The common objective in these externals is to help use and distribute python code and libraries in Max applications. Many can be considered experimental, with 80% of development time going to the first two externals (`py` and `pyjs`), with `py` receiving most of recent attention, especially with respect to its builtin `api` module which uses cython to wrap an incrementally growing subset of the Max c-api. Please see below for an overview and feature comparison.
 
 At the time of this writing, and since the switch to [max-sdk-base](https://github.com/cycling74/max-sdk-base), the project has the following compatibility profile:
 
@@ -193,7 +193,7 @@ Look at the `Makefile` and the root `CMakeLists.txt` for further specialized bui
 
 After doing the above, the recommended iterative development workflow is to make changes to the source code in the respective project and then `cd py-js/build` and `cmake --build .`. This will cause cmake to only build modified projects efficiently.
 
-Note that for some of the less developed externals and more experimental features please don't be surprised if Max seg-faults (especially if you start experimenting with the cython wrapped `api` module which operates on the c-level of the Max SDK).
+Note that for some of the less developed externals and more experimental features please don't be surprised if Max occassionaly segfaults (especially if you start experimenting with the the more experimental parts of the cython wrapped `api` module which operates on the c-level of the Max SDK).
 
 Also note that for `py` and `pyjs` externals the `cmake` build method described does not yet create self-contained python externals which can be used in Max Packages and Standalones. The [Building self-contained Python3 Externals for Packages and Standalones](https://github.com/shakfu/py-js/tree/main/source/projects/py#building-self-contained-python3-externals-for-packages-and-standalones) section addresses this requirement.
 

TODO.md

@@ -1,6 +1,6 @@
 # TODO
 
-- [ ] Create project-level userguide (in-progress in `pyjs/source/docs`)
+- [x] Create project-level userguide (in-progress in `pyjs/source/docs`)
 
 - [ ] Move `builder` to `py-js/source/scripts/builder`
 

source/projects/py/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [0.3.x]
 
+- Added `__repr__` methods to all extension classes.
+
+- Added `api.MaxObject` attr-related methods: `add_attribute`, `remove_attribute`, `set_attr_value`, `get_attr_value`
+
 - Added optional optimization/stripping configuration which can reduce external sizes by 14%
 
 - Added many unimplemented methods to `api.Table`

source/projects/py/TODO.md

@@ -16,9 +16,9 @@
 
 ## api
 
-### Core
+### Wrapper Class Features
 
-### Usability
+- [ ] add [buffer control](https://cython.readthedocs.io/en/latest/src/userguide/buffer.html) support to `api.Matrix` to facilitate reading and writing to matrices along the lines of what was done with the `api.Buffer` wrapper.
 
 ### Extensibility
 
@@ -32,8 +32,6 @@
 
 ### Testing
 
-- [ ] convert `py_coll_tester` into bpatcher that can be fed by `py_repl`
-
 - [ ] list remaining tests to implement
 
 - [ ] complete comprehensive test suite
@@ -59,25 +57,20 @@
 ### Max API Wrapper
 
 - [x] add more tests and examples
+  - [ ] complete tests for remaining extension classes
 
 ### Build System
 
 - [ ] Change python variant product names to include python version and architecture (and platform), for example: `shared-ext-3711-x86`
 
-- [ ] Normalize tiny-variant names: so `shared-tiny-ext` becomes `shared-ext-tiny` and `static-tiny-ext` becomes `static-ext-tiny`.
-
 - [ ] Each python or pyjs build variant such as `shared-pkg` or `shared-ext`, should produce a unique output, and there should be a dependency mgmt solution which includes a clear dep graph and hashing and caching to minimize unecessary builds and rebuilds
 
-- [ ] Develop a configuration based api for `builder` which can consume yaml, json or a python api.
+- [ ] Develop a configuration based api for `builder` which can consume yaml, json or similar simple configuration.
 
-- [ ] add NUMPY_INCLUDE var to all xcode projects
-
-- [ ] add `-framework MaxAudioAPI -framework JitterAPI` to OTHER_LDFLAGS in all xcode projects.
+- [x] add NUMPY_INCLUDE var to all xcode projects
 
 - [ ] `min-setup.local` patch system needs to be organized and automated and linked to modules so that options lead to proper removal of extensions and modules with clear dependencies.
 
-- [ ] If a patch is not found, default to a standard working path or no patch at all
-
 - [ ] Add warning for `shared-ext` being opened up one after the other, Max will crash because it caches the former.
 
 ### Future Experiments