format markdown files and update TODO

Author: JackismyShephard

README.md

@@ -13,9 +13,10 @@ An extension of [AiCoverGen](https://github.com/SociallyIneptWeeb/AICoverGen), w
 Ultimate RVC is under constant development and testing, but you can try it out right now locally or on Google Colab!
 
 ## Youtube Showcase
+
 * [Ultimate RVC: The Most Powerful AI Voice Cloning Tool Yet!](https://www.youtube.com/watch?v=dVpCF68JpNg)
 * [Ultimate-RVC on Your PC | Turn Any Voice Into Yours!](https://www.youtube.com/watch?v=IxFgz50y1AY)
-* [ Train Any Voice with Ultimate RVC | Fast & Accurate Voice Cloning](https://www.youtube.com/watch?v=O7VeYLL3H-c)
+* [Train Any Voice with Ultimate RVC | Fast & Accurate Voice Cloning](https://www.youtube.com/watch?v=O7VeYLL3H-c)
 
 Courtesy of [Social & Apps](https://www.youtube.com/@socialapps1194)
 
@@ -44,7 +45,7 @@ To setup the project follow the steps below and execute the provided commands in
 
 ### Install Git
 
-Follow the instructions [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) to install Git on your computer.
+Follow the [Git installation instructions](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) to install Git on your computer.
 
 ### Set execution policy (Windows only)
 
@@ -145,7 +146,7 @@ The Ultimate RVC project package can then be installed as follows:
 pip install ultimate-rvc
 ```
 
-### Usage
+### CLI Usage
 
 The `ultimate-rvc` package can be used as a python library but is primarily intended to be used as a command line tool. The package exposes two top-level commands:
 

notes/TODO.md

@@ -1,7 +1,20 @@
 # TODO
 
+* figure out a way of safely storing PyPI credentials
+* promote dependencies to latest versions
+  * and do proper testing before committing
+* setup testing with pytest
+  * setup folder structure for tests
+  * configure required dependencies in `pyproject.toml`
+    * pytest, faker
+  * setup pytest configuration in `pyproject.toml`
+  * setup pytest pre-commit hook
+* setup test coverage
+  * first research best framework for this in python
+* setup auto documentation generation
+
 * fix configuration saving/loading so that visibility status can also be saved and loaded
-  * this needs to be done statically: when defining a configuration component there should be an optional children field which denotes the children of the component that will be unfolded, i.e. shouldb become visible. There hsould also (perhaps on the same field) be a defined value for which the child components should be visible. Then during the saving of new component values, we will do a check where we see if a given component has any children. if so and if the new component value is equal to the value for which the children should become visible, then we set the visibility field on the children to true. 
+  * this needs to be done statically: when defining a configuration component there should be an optional children field which denotes the children of the component that will be unfolded, i.e. shouldb become visible. There hsould also (perhaps on the same field) be a defined value for which the child components should be visible. Then during the saving of new component values, we will do a check where we see if a given component has any children. if so and if the new component value is equal to the value for which the children should become visible, then we set the visibility field on the children to true.
   * When this has been implemented we can finally have all the components with children be included rather than excluded from saving and loading as is the case now (and of course the visiblity of their children will be saved too)
 
 * remodularize frontend code to reflect new tab layout
@@ -85,11 +98,11 @@
   * Possible solutions
     * use gr.browserstate to allow state to be preserved acrross page loads.
     * Save any changes to components to a session dictionary and load from it upon refresh
-      * See [here](https://github.com/gradio-app/gradio/issues/3106#issuecomment-1694704623)
+      * See [this GitHub issue comment](https://github.com/gradio-app/gradio/issues/3106#issuecomment-1694704623)
       * Problem is that this solution might not work with accordions or other types of blocks
             * should use .expand() and .collapse() event listeners on accordions to programmatically reset the state of accordions to what they were before after user has refreshed the page
     * Use localstorage
-      * see [here](https://huggingface.co/spaces/YiXinCoding/gradio-chat-history/blob/main/app.py) and [here](https://huggingface.co/spaces/radames/gradio_window_localStorage/blob/main/app.py)
+      * see [this chat history example](https://huggingface.co/spaces/YiXinCoding/gradio-chat-history/blob/main/app.py) and [this localStorage example](https://huggingface.co/spaces/radames/gradio_window_localStorage/blob/main/app.py)
 
     * Whenever the state of a component is changed save the new state to a custom JSON file.
       * Then whenever the app is refreshed load the current state of components from the JSON file
@@ -128,7 +141,7 @@
 
 ## Core
 
-### Common
+### Common Features
 
 * instead of having custom embedder models, just allow users to upload new embedder models which will be shown in the main embedder models dropdown (and perhaps also saved in the main embedder models dir?)
 
@@ -403,9 +416,11 @@
   * when ultimate rvc is downloaded as a pypi package the exposed commands are much faster so investigate this
 
 ## GitHub
+
 * setup discussions forum on repo
 * add support me/by me coffee section on readme
 * add an acknowledgements section to readme
+
 ### Actions
 
 * linting with Ruff

notes/app-doc.md

@@ -5,7 +5,7 @@ Run the Ultimate RVC web application.
 **Usage**:
 
 ```console
-$ main [OPTIONS]
+main [OPTIONS]
 ```
 
 **Options**:

notes/cli-doc.md

@@ -5,7 +5,7 @@ CLI for the Ultimate RVC project
 **Usage**:
 
 ```console
-$ urvc-cli [OPTIONS] COMMAND [ARGS]...
+urvc-cli [OPTIONS] COMMAND [ARGS]...
 ```
 
 **Options**:
@@ -25,7 +25,7 @@ Generate song covers
 **Usage**:
 
 ```console
-$ urvc-cli song-cover [OPTIONS] COMMAND [ARGS]...
+urvc-cli song-cover [OPTIONS] COMMAND [ARGS]...
 ```
 
 **Options**:
@@ -43,7 +43,7 @@ Run the song cover generation pipeline.
 **Usage**:
 
 ```console
-$ urvc-cli song-cover run-pipeline [OPTIONS] SOURCE MODEL_NAME
+urvc-cli song-cover run-pipeline [OPTIONS] SOURCE MODEL_NAME
 ```
 
 **Arguments**:

notes/prioritized_todo.md

@@ -4,7 +4,7 @@
 
 * rework other settings tab
   * this should also contain other settings such as the ability to change the theme of the app
-      * Add Support for changing theme in app?
+    * Add Support for changing theme in app?
   * there should be a button to apply settings which will reload the app with the new settings
 
 * move all post processing from vocal conversion step to postprocessing step
@@ -47,10 +47,9 @@
 * figure out way of making ./urvc commands execute faster
   * when ultimate rvc is downloaded as a pypi package the exposed commands are much faster so investigate this
 
-
 * Add example audio files to use for testing
   * Should be located in `audio/examples`
   * could have sub-folders `input` and `output`
     * in `output` folder we have `output_audio.ext` files each with a corresponding `input_audio.json` file containing metadata explaining arguments used to generate output
     * We can then test that actual output is close enough to expected output using audio similarity metric.
-* Setup unit testing framework using pytest
+* Setup unit testing framework using pytest