0.1.0

Author: anandsshah

.github/workflows/main.yml

@@ -137,7 +137,5 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
-# Until testing doesn't work, I will use main.py
+# Just easier than running tests
 main.py
-tests/assets/*.flp
-tests/assets/*.flp.bak

.gitignore

@@ -0,0 +1,11 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 19.3b0
+    hooks:
+    -   id: black

.pre-commit-config.yaml

@@ -1,4 +1,5 @@
 {
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
-}
+    "python.testing.pytestEnabled": true,
+    "python.formatting.provider": "black"
+}

.vscode/settings.json

@@ -0,0 +1,40 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "black",
+            "type": "shell",
+            "command": "black .",
+            "problemMatcher": []
+        },
+        {
+            "label": "tests",
+            "type": "shell",
+            "command": "py.test",
+            "problemMatcher": []
+        },
+        {
+            "label": "build",
+            "type": "shell",
+            "command": "py -3.9 -m build .",
+            "problemMatcher": [],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        },
+        {
+            "label": "docs",
+            "type": "shell",
+            "command": "cd docs && ./make html",
+            "problemMatcher": []
+        },
+        {
+            "label": "mypy",
+            "type": "shell",
+            "command": "mypy . --no-strict-optional"
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,33 @@
+# 0.1.0
+
+## **Highlights**
+
+- `flpinspect` - An FLP Event Viewer made using Tkinter.
+- `flpinfo` - A CLI utility to get basic information about an FLP.
+- Switched to MIT License
+
+## Additions
+
+- Lots of changes, refactoring and code cleanup of `pyflp`
+- New docs
+- Changes to `README`
+- Adopted [`black`](https://github.com/psf/black) coding style
+- Added a `log_level` argument to `Parser`
+- `Project.create_zip` copies stock samples as well now
+- `Project.get_events` for getting just the events; they are not parsed.
+  Read [docs](https://pyflp.rtfd.io) for more info about this
+- `Event` classes now have an `__eq__` and `__repr__` method
+
+## Bug fixes
+
+- Tests don't give module import errors
+- `Pattern` event parsing
+- Initialise `_count` to 0, everytime `Parser` is initialised
+- `Project.create_zip` now works as intended
+- Overhauled logging
+- A lot of potential bugs in `FLObject` subclasses
+
+## Known issues
+
+- `flpinfo` doesn't output correctly sometimes due to long strings
+- Extraneous data dumped sometimes by `InsertSlotEvent.Plugin`, why this is caused is not known

CHANGELOG.md

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS 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.
+SOFTWARE.

LICENSE

@@ -0,0 +1,11 @@
+include *.md
+include tox.ini
+recursive-include docs *.bat
+recursive-include docs *.md
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs Makefile
+recursive-include pyflp *.py
+recursive-include tests *.md
+recursive-include tests *.py
+recursive-include tests *.flp

MANIFEST.in

@@ -1,28 +1,48 @@
 [![Documentation Status](https://readthedocs.org/projects/pyflp/badge/?version=latest)](https://pyflp.readthedocs.io/en/latest/?badge=latest)
 ![PyPI - License](https://img.shields.io/pypi/l/pyflp)
 ![PyPI](https://img.shields.io/pypi/v/pyflp?color=blue)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyflp)
+![Code Style: Black](https://img.shields.io/badge/code%20style-black-black)
 
 # PyFLP
-PyFLP creates an object from an FLP. You can edit it and save it back also. *Please don't use this for serious stuffs, I have done minimal testing myself and much of the features are yet to be implemented.*
 
-It also has useful utilities like:
-* Creating a ZIP looped package from an FLP
+PyFLP allows an object oriented access to an FLP. This provides an abstraction from its TLV implementation. _Please don't use this for serious stuffs yet._
+
+You should also check these:
+- A CLI utility **FLPInfo** to see basic information about an FLP.
+- A GUI tool **FLPInspect** for a further, detailed view into the internal structure of an FLP.
 
 ## Usage
+
+PyFLP can be used for automation purposes e.g. finding/setting project titles, artists names, genre etc. and also by people who are interested more about the FLP format. You can even repair a broken FLP, *ofcourse by yourself*.
+
+### Initialisation
+
 ```{code-block} python
-from pyflp.parser import ProjectParser
-project = ProjectParser().parse("/path/to/efelpee.flp")
+from pyflp import Parser
+project = Parser(verbose=True).parse("/path/to/efelpee.flp")
+```
+
+### Saving
 
-# Use ProjectParser(verbose=True) if you want to see logs
+```{code-block} python
+project.save(save_path="/path/to/save.flp")
+```
+
+### Export it as a ZIP looped package
+
+```{code-block} python
+project.create_zip(path="/path/to/flp.zip")
 ```
 
 ## Installation
 
-```{code-block}
+```
 pip install pyflp
 ```
 
 ## Testing
+
 I have created a [null test](tests/test_parser.py). More tests need to be added.
 
 ## Thanks
@@ -33,4 +53,4 @@ I have created a [null test](tests/test_parser.py). More tests need to be added.
 
 ## Contributions
 
-If you can spare some time for testing and/or contributing, I would be very grateful. Please check the [TODO](TODO.md) as well for current goals/issues. You can reach me at **demberto**[at]**protonmail**[dot]**com** as well :)
+If you can spare some time for testing and/or contributing, I would be very grateful. Please check the [TODO](TODO.md) as well for current goals/issues. Its kind of getting difficult for me as this project becomes bigger. You can reach me at **demberto**[at]**protonmail**[dot]**com** as well :)

README.md

@@ -1,9 +1,27 @@
-* `Misc.start_date` parse logic raises **OverflowError**
-* **repr()** for `FLObject` subclasses
-* `max_count` - required or not?
-* Use the same event system used in other FLObjects for `Plugin` but make the `save()` method recombine it into a single event (Events inside event)
-* Instead of creating objects in a single go, create them in multiple layers of parsing. I think this is what FL also does
-* `PatternEventID.New` event occurs twice, doesn't get dumped twice as parsing logic replaces previous instance when it occurs 2nd time
-* Test for verifying that the data chunk length == size of events
-* `Project.save()` must check for changed to certain `Misc` properties, which cannot be set by `Misc` itself as they are not events.
-* Pattern controller events
+### PyFLP
+
+- `Misc.start_date` parse logic raises **OverflowError**
+- **repr()** for `FLObject` subclasses
+- Use the same event system used in other FLObjects for `Plugin` but make the `save()` method recombine it into a single event (Events inside event)
+- Instead of creating objects in a single go, create them in multiple layers of parsing. I think this is what FL also does
+- Test for verifying that the data chunk length == size of events
+- Pattern controller events
+- `_count` variables being static become useless when `Parser` is reinitalised
+- Switch over to [`BytesIOEx`](https://github.com/demberto/bytesioex)
+- First pattern doesn't get a name after saving
+- Saving an FLP back into a ZIP
+- Extraneous data dumped sometimes by `InsertSlotEvent.Plugin`, why this is caused is not known
+
+### FLPInspect
+
+- Progress bar
+- Fix high CPU usage
+- Support event editing
+- Warnings and errors are ignored by `GUIHandler` if verbose mode is not enabled
+- Tooltips are a mess
+- Tests
+
+### FLPInfo
+
+- Long comments cause incorrect formatting
+- Tests