Merge pull request noisebridge#61 from noisebridge/58-connect-wiki_to…

…_netflixmongo-insertionmain-file

Refactor main file/commands and expand dataclass usage

README.md

@@ -12,7 +12,7 @@ This code uses Python 3. It is tested on Python 3.12, but will probably work on
 
 To install the project dependencies, first install pipenv globally with `pip install pipenv`. Then create a virtual env/install dependencies with `pipenv install --dev`.
 
-To run code in the pipenv virtual environment, prefix your command with `pipenv run` (ex. `pipenv run dev` runs the development script).
+To run code in the pipenv virtual environment, prefix your command with `pipenv run` (ex. `pipenv run python` runs the python interpreter in the pipenv environment).
 
 ### Using the pipenv environment in VSCode
 
@@ -30,18 +30,21 @@ For development purposes, you can simply run the dev script:
 pipenv run dev
 ```
 
-This is currently just an alias to run the main script using `pipenv run python -m mediabridge.main`, but this may change in the future, so using `pipenv run dev` will be ensure the correct script is always run.
+Be sure to specify options such as -v and -l *before* any subcommands (process, load, etc.).  
 
 **NOTE:** *If you encounter a ModuleNotFoundError, make sure you are in the root directory of the project, as the `mediabridge` directory is the module Pipenv is trying to reference.*
 
+This is currently just an alias to run the main script using `pipenv run python -m mediabridge.main`, but this may change in the future, so using `pipenv run dev` will ensure the correct script is always run.
+
 ## Testing
 
-To run unit tests,
+To run unittests:
 
-1. Ensure `pipenv` is installed
-2. Run `pipenv run test`
+```
+pipenv run test
+```
 
-There is a GitHub actions "check" for passing tests, which must pass for you to be able to merge your PR.
+These tests are also evaluated via a GitHub action when opening or updating a PR and must pass before merging.
 
 ## Code formatting