PyLibMS 5.0.6__tar.gz → 5.0.7__tar.gz

{pylibms-5.0.6 → pylibms-5.0.7}/PKG-INFO

@@ -1,12 +1,14 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 5.0.6
+Version: 5.0.7
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, UMSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
 Project-URL: Repository, https://github.com/AbdyyEee/PylibMS
-Project-URL: Documentation, https://github.com/AbdyyEee/PylibMS/wiki
+Project-URL: Documentation, https://pylibms.readthedocs.io/en/latest/
 Keywords: nintendo,msbt,umsbt,message text,msbp,message project,msbf,message flowchart,flw3,modding,libmessagestudio
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -17,6 +19,9 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML>=6.0.3
 Requires-Dist: requests>=2.34.2
+Provides-Extra: docs
+Requires-Dist: sphinx>=8.0.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
 Dynamic: license-file
 
 # PyLibMS
@@ -26,25 +31,22 @@ Dynamic: license-file
 [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
 ![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)
 
-PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file
-formats from Nintendo.
+PyLibMS is a library built in Python 3.11 and above for reading and writing of revision >=3 of the libMessageStudio
+(LMS) proprietary file formats from Nintendo. These include files generated for late **Wii** titles, **Nintendo 3DS**,
+**Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
 
 The following is supported:
 
-| Format | Read | Write | Support                                                                                                                                                                                  |
-|--------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `MSBT` | ✅   | ✅    | 1:1 Reading and writing. Support for majority of sections. Full attribute (`ATR1`) decoding with configurations. Tag decoding 1:1 with the official Nintendo `.mstxt` file format.        |
-| `UMSBT` | ✅   | ✅   | 1:1 Reading and writing. Accessing, adding, inserting and deleting `MSBT` files within `UMSBT` archives. |
-| `MSBF` | ✅   | ✅    | 1:1 Reading and writing flowcharts (`FLW3`). Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games. |
-| `MSBP` | ✅   | ❌    | Viewing all MSBP relevant metadata and generating configuration files for use with `MSBT` files.                                                                                         |
+| Format  | Read | Write | Support                                                                                                                                                                                  |
+|---------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `MSBT`  | ✅   | ✅    | 1:1 Reading and writing. Support for majority of sections. Full attribute (`ATR1`) decoding with configurations. Tag decoding 1:1 with the official Nintendo `.mstxt` file format.       |
+| `UMSBT` | ✅   | ✅    | 1:1 Reading and writing. Accessing, adding, inserting and deleting `MSBT` files within `UMSBT` archives.                                                                                 |
+| `MSBF`  | ✅   | ✅    | 1:1 Reading and writing flowcharts (`FLW3`). Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games. |
+| `MSBP`  | ✅   | ❌    | Viewing all MSBP relevant metadata and generating configuration files for use with `MSBT` files.                                                                                         |                                                                        |
 
-This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles,
-**Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
+# Documentation
 
-# Features and Usage
-
-Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations
-and examples.
+PyLibMS documentation is on [readthedocs](https://pylibms.readthedocs.io/en/latest/). A simple preview is below:
 
 ## Reading
 
@@ -95,6 +97,8 @@ To add or edit Preset, you may create an issue with the relevant `yaml` file and
 
 # Installation
 
+Python version must be `>=3.11.
+
 ```
 pip install PyLibMS
 ```
@@ -103,9 +107,7 @@ pip install PyLibMS
 
 # Build Instructions
 
-Python version must be `3.11` or higher.
-
-Clone the repository, then run `pip install` (venv recommended)
+Clone the repository, then run `pip install`.
 
 ```bash
 git clone https://github.com/AbdyyEee/PylibMS.git
@@ -115,7 +117,13 @@ pip install -e .
 
 # AI Disclaimer
 
-Code in this library was written by me. AI was utilized occasionally when developing MSBT (specifically tag string importing) , MSBF and assisting in creating unit tests. 
+PyLibMS and its code is handwritten, developed and maintained by abdyyeee.
+
+AI was occasionally consulted for minor implementation references during the development of MSBT, USMBT and MSBF. No AI
+was utilized for MSBP. Any references were reviewed and tested beforehand, and no code was ever directly pasted from any
+generative source.
+
+The development of unit-tests were AI assisted.
 
 # Credits & Sources
 

{pylibms-5.0.6 → pylibms-5.0.7}/PyLibMS.egg-info/PKG-INFO

@@ -1,12 +1,14 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 5.0.6
+Version: 5.0.7
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, UMSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
 Project-URL: Repository, https://github.com/AbdyyEee/PylibMS
-Project-URL: Documentation, https://github.com/AbdyyEee/PylibMS/wiki
+Project-URL: Documentation, https://pylibms.readthedocs.io/en/latest/
 Keywords: nintendo,msbt,umsbt,message text,msbp,message project,msbf,message flowchart,flw3,modding,libmessagestudio
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -17,6 +19,9 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML>=6.0.3
 Requires-Dist: requests>=2.34.2
+Provides-Extra: docs
+Requires-Dist: sphinx>=8.0.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
 Dynamic: license-file
 
 # PyLibMS
@@ -26,25 +31,22 @@ Dynamic: license-file
 [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
 ![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)
 
-PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file
-formats from Nintendo.
+PyLibMS is a library built in Python 3.11 and above for reading and writing of revision >=3 of the libMessageStudio
+(LMS) proprietary file formats from Nintendo. These include files generated for late **Wii** titles, **Nintendo 3DS**,
+**Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
 
 The following is supported:
 
-| Format | Read | Write | Support                                                                                                                                                                                  |
-|--------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `MSBT` | ✅   | ✅    | 1:1 Reading and writing. Support for majority of sections. Full attribute (`ATR1`) decoding with configurations. Tag decoding 1:1 with the official Nintendo `.mstxt` file format.        |
-| `UMSBT` | ✅   | ✅   | 1:1 Reading and writing. Accessing, adding, inserting and deleting `MSBT` files within `UMSBT` archives. |
-| `MSBF` | ✅   | ✅    | 1:1 Reading and writing flowcharts (`FLW3`). Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games. |
-| `MSBP` | ✅   | ❌    | Viewing all MSBP relevant metadata and generating configuration files for use with `MSBT` files.                                                                                         |
+| Format  | Read | Write | Support                                                                                                                                                                                  |
+|---------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `MSBT`  | ✅   | ✅    | 1:1 Reading and writing. Support for majority of sections. Full attribute (`ATR1`) decoding with configurations. Tag decoding 1:1 with the official Nintendo `.mstxt` file format.       |
+| `UMSBT` | ✅   | ✅    | 1:1 Reading and writing. Accessing, adding, inserting and deleting `MSBT` files within `UMSBT` archives.                                                                                 |
+| `MSBF`  | ✅   | ✅    | 1:1 Reading and writing flowcharts (`FLW3`). Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games. |
+| `MSBP`  | ✅   | ❌    | Viewing all MSBP relevant metadata and generating configuration files for use with `MSBT` files.                                                                                         |                                                                        |
 
-This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles,
-**Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
+# Documentation
 
-# Features and Usage
-
-Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations
-and examples.
+PyLibMS documentation is on [readthedocs](https://pylibms.readthedocs.io/en/latest/). A simple preview is below:
 
 ## Reading
 
@@ -95,6 +97,8 @@ To add or edit Preset, you may create an issue with the relevant `yaml` file and
 
 # Installation
 
+Python version must be `>=3.11.
+
 ```
 pip install PyLibMS
 ```
@@ -103,9 +107,7 @@ pip install PyLibMS
 
 # Build Instructions
 
-Python version must be `3.11` or higher.
-
-Clone the repository, then run `pip install` (venv recommended)
+Clone the repository, then run `pip install`.
 
 ```bash
 git clone https://github.com/AbdyyEee/PylibMS.git
@@ -115,7 +117,13 @@ pip install -e .
 
 # AI Disclaimer
 
-Code in this library was written by me. AI was utilized occasionally when developing MSBT (specifically tag string importing) , MSBF and assisting in creating unit tests. 
+PyLibMS and its code is handwritten, developed and maintained by abdyyeee.
+
+AI was occasionally consulted for minor implementation references during the development of MSBT, USMBT and MSBF. No AI
+was utilized for MSBP. Any references were reviewed and tested beforehand, and no code was ever directly pasted from any
+generative source.
+
+The development of unit-tests were AI assisted.
 
 # Credits & Sources
 

{pylibms-5.0.6 → pylibms-5.0.7}/PyLibMS.egg-info/SOURCES.txt

@@ -1,5 +1,4 @@
 LICENSE
-MANIFEST.in
 README.md
 pyproject.toml
 PyLibMS.egg-info/PKG-INFO

pylibms-5.0.7/PyLibMS.egg-info/requires.txt

@@ -0,0 +1,6 @@
+PyYAML>=6.0.3
+requests>=2.34.2
+
+[docs]
+sphinx>=8.0.0
+sphinx-rtd-theme>=2.0

{pylibms-5.0.6 → pylibms-5.0.7}/README.md

@@ -5,25 +5,22 @@
 [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
 ![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)
 
-PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file
-formats from Nintendo.
+PyLibMS is a library built in Python 3.11 and above for reading and writing of revision >=3 of the libMessageStudio
+(LMS) proprietary file formats from Nintendo. These include files generated for late **Wii** titles, **Nintendo 3DS**,
+**Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
 
 The following is supported:
 
-| Format | Read | Write | Support                                                                                                                                                                                  |
-|--------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `MSBT` | ✅   | ✅    | 1:1 Reading and writing. Support for majority of sections. Full attribute (`ATR1`) decoding with configurations. Tag decoding 1:1 with the official Nintendo `.mstxt` file format.        |
-| `UMSBT` | ✅   | ✅   | 1:1 Reading and writing. Accessing, adding, inserting and deleting `MSBT` files within `UMSBT` archives. |
-| `MSBF` | ✅   | ✅    | 1:1 Reading and writing flowcharts (`FLW3`). Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games. |
-| `MSBP` | ✅   | ❌    | Viewing all MSBP relevant metadata and generating configuration files for use with `MSBT` files.                                                                                         |
+| Format  | Read | Write | Support                                                                                                                                                                                  |
+|---------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `MSBT`  | ✅   | ✅    | 1:1 Reading and writing. Support for majority of sections. Full attribute (`ATR1`) decoding with configurations. Tag decoding 1:1 with the official Nintendo `.mstxt` file format.       |
+| `UMSBT` | ✅   | ✅    | 1:1 Reading and writing. Accessing, adding, inserting and deleting `MSBT` files within `UMSBT` archives.                                                                                 |
+| `MSBF`  | ✅   | ✅    | 1:1 Reading and writing flowcharts (`FLW3`). Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games. |
+| `MSBP`  | ✅   | ❌    | Viewing all MSBP relevant metadata and generating configuration files for use with `MSBT` files.                                                                                         |                                                                        |
 
-This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles,
-**Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
+# Documentation
 
-# Features and Usage
-
-Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations
-and examples.
+PyLibMS documentation is on [readthedocs](https://pylibms.readthedocs.io/en/latest/). A simple preview is below:
 
 ## Reading
 
@@ -74,6 +71,8 @@ To add or edit Preset, you may create an issue with the relevant `yaml` file and
 
 # Installation
 
+Python version must be `>=3.11.
+
 ```
 pip install PyLibMS
 ```
@@ -82,9 +81,7 @@ pip install PyLibMS
 
 # Build Instructions
 
-Python version must be `3.11` or higher.
-
-Clone the repository, then run `pip install` (venv recommended)
+Clone the repository, then run `pip install`.
 
 ```bash
 git clone https://github.com/AbdyyEee/PylibMS.git
@@ -94,7 +91,13 @@ pip install -e .
 
 # AI Disclaimer
 
-Code in this library was written by me. AI was utilized occasionally when developing MSBT (specifically tag string importing) , MSBF and assisting in creating unit tests. 
+PyLibMS and its code is handwritten, developed and maintained by abdyyeee.
+
+AI was occasionally consulted for minor implementation references during the development of MSBT, USMBT and MSBF. No AI
+was utilized for MSBP. Any references were reviewed and tested beforehand, and no code was ever directly pasted from any
+generative source.
+
+The development of unit-tests were AI assisted.
 
 # Credits & Sources
 

{pylibms-5.0.6 → pylibms-5.0.7}/lms/message/umsbt.py

@@ -38,12 +38,12 @@ class UMSBT:
 
     @property
     def files(self) -> tuple[MSBT, ...]:
-        """Maps of files tied to this instance."""
+        """List of files tied to this instance."""
         return tuple(self._files)
 
     @property
     def file_map(self) -> Mapping[str, MSBT]:
-        """Maps of files tied to this instance."""
+        """Maps of file to their name tied to this instance."""
         return MappingProxyType({msbt.filename: msbt for msbt in self._files})
 
     def add_msbt(self, msbt: MSBT) -> None:

{pylibms-5.0.6 → pylibms-5.0.7}/pyproject.toml

@@ -7,7 +7,7 @@ include = ["lms*"]
 
 [project]
 name = "PyLibMS"
-version = "5.0.6"
+version = "5.0.7"
 requires-python = ">=3.11"
 description = "Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, UMSBT, MSBP, and MSBF."
 readme = "README.md"
@@ -27,6 +27,8 @@ keywords = [
 license = "MIT"
 license-files = ["LICENSE*"]
 classifiers = [
+    "Topic :: Software Development :: Libraries",
+    "Operating System :: OS Independent",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -38,6 +40,12 @@ dependencies = [
     "requests>=2.34.2"
 ]
 
+[project.optional-dependencies]
+docs = [
+    "sphinx>=8.0.0",
+    "sphinx-rtd-theme>=2.0"
+]
+
 [project.urls]
 Repository = "https://github.com/AbdyyEee/PylibMS"
-Documentation = "https://github.com/AbdyyEee/PylibMS/wiki"
+Documentation = "https://pylibms.readthedocs.io/en/latest/"

pylibms-5.0.6/MANIFEST.in

@@ -1 +0,0 @@
-include README.md LICENSE

pylibms-5.0.6/PyLibMS.egg-info/requires.txt

@@ -1,2 +0,0 @@
-PyYAML>=6.0.3
-requests>=2.34.2