Sphinx + License change

Author: anandsshah

.vscode/settings.json

@@ -7,5 +7,6 @@
         "test_*.py"
     ],
     "python.testing.pytestEnabled": false,
-    "python.testing.unittestEnabled": true
+    "python.testing.unittestEnabled": true,
+    "restructuredtext.confPath": "${workspaceFolder}\\docs"
 }

LICENSE

@@ -1,3 +1,7 @@
+[![Documentation Status](https://readthedocs.org/projects/pyflp/badge/?version=latest)](https://pyflp.readthedocs.io/en/latest/?badge=latest)
+![GitHub](https://img.shields.io/github/license/demberto/pyflp)
+![PyPI](https://img.shields.io/pypi/v/pyflp?color=blue)
+
 # 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.*
 
@@ -12,50 +16,21 @@ project = ProjectParser().parse("/path/to/efelpee.flp")
 # Use ProjectParser(verbose=True) if you want to see logs
 ```
 
-## [More about FLP Format](doc/flp-format.md)
-
-## [How does it work?](doc/how-does-it-work.md)
+## Installation
 
-# Classes
-
-## `Project`
-The main entry point. Created by `ProjectParser().parse()`
-
-```Python
-misc: Misc
-playlist: Playlist
-patterns: List[Pattern]
-filterchannels: List[FilterChannel]
-channels: List[Channel]
-arrangements: List[Arrangement]
-timemarkers: List[TimeMarker]
-tracks: List[Track]
-inserts: List[Insert]
-_unparsed_events: List[Event]
+```
+pip install pyflp
 ```
 
-Below are brief descriptions of the classes used above
-
-### `Misc`
-Stores many one-time events like project Artists, Title, Tempo, Save timestamp etc. Most of the work here is done.
-
-### `Pattern`
-Represents a pattern. Only `index`, `name` and `color` properties are implemented.
-
-### `Channel`
-Represents a channel. This includes everything visible in Channel Rack. Automation, Samplers, plain audio clips, instruments are treated as a channel by FL. At this point many essential properties of a channel are implemented and a lot more are yet to be done. 
-
-### `Insert`
-Represents a mixer track ("Insert" from here on). Only `name`, `color`, `routing` and `flags` (properties like whether an `Insert` is docked to the middle, left or right, whether it is locked or not) are implemented yet. `InsertSlot`s are also stored in an `Insert`.
+## [More about FLP Format](doc/flp-format.md)
 
-### `InsertSlot`
-Represents a mixer track channel ("insert slot" from here on). Like `Insert` only few basic properties like `name`, `color` and `index` are implemented.
+## [How does it work?](doc/how-does-it-work.md)
 
-### Unparsed events
-There are still many events which are not implemented. You can find them commented in one of the `*EventID` enums spread across the `FLObject` subclasses.
+## Documentation
+Docs are available on [Read The Docs](pyflp.rtfd.io)
 
 ## Testing
-I have created a [null test](tests/test_parser.py) and provided an empty FLP as well. However due to module import errors, I cannot get that test running :(
+I have created a [null test](test_parser.py). More tests need to be added.
 
 ## Thanks
 

README.md

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/Makefile

@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'PyFLP'
+copyright = '2021, demberto'
+author = 'demberto'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/conf.py

@@ -1,6 +1,6 @@
 # How does the parser work?
 
-*I recommend you to read [More about FLP Format](doc/flp-format.md) before this.*
+*I recommend you to read [More about FLP Format](flp-format.md) before this.*
 
 Since, FLP is an event-based binary format, we need to work with data types of C *(Delphi actually, because FL is written in Delphi, but Delphi's basic data types aren't different from C's data types)*. Python provides a nice way to read these types through the `struct` module. I made my own extension of `io.BytesIO` class named [`BytesIOEx`](../pyflp/bytesioex.py) which is inspired by C#'s `BinaryReader` and `BinaryWriter`. The extension `read_*` and `write_*` just convert raw bytes into a data type.
 

doc/flp-format.md docs/flp-format.mddoc/flp-format.md renamed to docs/flp-format.md

@@ -0,0 +1,20 @@
+.. PyFLP documentation master file, created by
+   sphinx-quickstart on Thu Sep 16 10:42:44 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PyFLP's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/how-does-it-work.md docs/how-does-it-work.mddoc/how-does-it-work.md renamed to docs/how-does-it-work.md

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/index.rst

@@ -12,6 +12,20 @@ class PanningLaw(enum.IntEnum):
     Circular = 0
     Triangular = 1
 
+VALID_PPQS = (
+    24,
+    48,
+    72,
+    96,
+    120,
+    144,
+    168,
+    192,
+    384,
+    768,
+    960
+)
+
 @enum.unique
 class MiscEventID(enum.IntEnum):
     Version = TEXT + 7
@@ -42,15 +56,43 @@ class MiscEventID(enum.IntEnum):
     Artists = TEXT + 15
     SaveTimestamp = DATA + 29
 
-@dataclasses.dataclass
 class Misc(FLObject):
-    ppq: int = dataclasses.field(init=False)
-    format: int = dataclasses.field(init=False)
-    channel_count: int = dataclasses.field(init=False)
-    
+    """Used for storing one time events, which don't fall into any other category"""
+
     _count = 0
     max_count = 1
 
+    @property
+    def ppq(self) -> Optional[int]:
+        """Pulses Per Quarter"""
+        return getattr(self, '_ppq', None)
+
+    @ppq.setter
+    def ppq(self, value: int):
+        assert value in VALID_PPQS, \
+            f"Invalid PPQ; expected one from {VALID_PPQS}; got {value}"
+        self._ppq = value
+        # TODO: How to change?
+    
+    @property
+    def format(self) -> Optional[int]:
+        return getattr(self, '_format', None)
+
+    @format.setter
+    def format(self, value: int):
+        self._format = value
+        # TODO: How to change?
+    
+    @property
+    def channel_count(self) -> Optional[int]:
+        """Total number of channels in the rack."""
+        return getattr(self, '_channel_count', None)
+
+    @channel_count.setter
+    def channel_count(self, value: int):
+        self._channel_count = value
+        # TODO: How to change?
+    
     @property
     def loop_active(self) -> Optional[bool]:
         """Whether a portion of the song is selected."""
@@ -126,6 +168,7 @@ def regname(self, value: str):
     # TODO: Use pathlib.Path instead of str
     @property
     def data_path(self) -> Optional[str]:
+        """Project settings -> Data folder"""
         return getattr(self, '_data_path', None)
 
     @data_path.setter
@@ -213,7 +256,7 @@ def current_filterchannel_num(self, value: int):
 
     @property
     def panning_law(self) -> Optional[PanningLaw]:
-        """Currently selected pattern number."""
+        """Project settings -> Advanced -> Panning law."""
         return getattr(self, '_panning_law', None)
 
     @panning_law.setter