Update README.md and export interface through __init__.py

Author: CowKeyMan

README.md

@@ -1,29 +1,27 @@
 # Pipeline Component System (PCS)
 
-TODO
-
 A strange programming framework
 
 The name is inspired by Entity Component System (ECS)
 
 ## Why?
 
-Why create this? I often find myself not liking the programs I create, and then end up rewriting them to be better, but they still end up quite brittle. This is a programming framework to make code cleaner and hopefully more maintainable. Have I succeeded in my goal? I have been using this framework for some time now and it has definitely helped my development speed and mental fatigue a lot! So yes, it has helped me achieve my goal!
+I often find myself not liking the programs I create, and then end up rewriting them to be better, but they still end up quite brittle. This is a programming framework to make code cleaner and hopefully more maintainable. Have I succeeded in my goal? I have been using this framework for some time now and it has definitely helped my development speed and mental fatigue a lot! So yes, it has helped me achieve my goal!
 
 ## Introduction
 
-I will first discuss the few simple components which make up this framework, then connect them together, explaining choices I took along the way. If you wish to see an example of how this all ties together, look at `examples/example.py`.
+I will first discuss the few simple elements which make up this framework, then connect them together, explaining choices I took along the way. If you wish to see an example of how this all ties together, look at `examples/example.py`.
 
 ### Component
 
-Think of the component as your global database. Each piece of persistent data (literal or object) is stored here. It is a dataclass, and it is the only dataclass (unless you want to nest them ofcourse). The reason for this design choice is that this way, we ALWAYS know where the data is. We do not have to guess which class owns what, like in those OOP messes.
+Think of the component as your global database. Each piece of persistent data (static or dyamic) is stored here. It is a dataclass, and it is the only dataclass (unless you want to nest them ofcourse). The reason for this design choice is that this way, we ALWAYS know where the data is. We do not have to guess which class owns what, unlike OOP soups.
 
-The Component distinguishes between 2 data types: config (constant / defined at the start then not changed after initialization) and runtime (dynamic data which changes during runtime). The config variables can only be of primitive types (a restriction which comes from omegaconf, which this project depends on). Whereas the config class is
+The Component distinguishes between 2 data types: `conf` (constant / static / defined at the start then remains read-only after initialization) and `runtime` (dynamic data which changes during runtime). The config variables can only be of primitive types (a restriction which comes from omegaconf, which this project depends on).
 
 ```python
 @dataclass
 class Config:  # Note: the name is not important
-    i: int  # Only primitive types in the config class
+    i: int  # Only primitive types in the config class (whatever OmegaConf is capable of)
     f: float
     s: str
     result: float
@@ -33,6 +31,7 @@ class Dynamic:
     di: int  # Dynamic class can also take complex types
 
 data = parse_arguments_cli(Config, Dynamic)
+data.seal()  # Makes the `Config` part of the component read-only
 
 print(data.i)  # Print's the Config class' 'i'
 print(data.di)  # Print's the Runtime class' 'i'
@@ -67,25 +66,34 @@ A pipeline takes a component, and a list of systems, then automatically passes t
 An example pipeline looks like this:
 
 ```python
-component = Component(1, 2, 'hello', -1)
 pipeline = Pipeline(
-    component, [print_add_system, result_add_system, result_add_system2]
+    component,
+    [
+        print_add_system,
+        result_add_system,
+        result_add_system2,
+    ]
 )
 pipeline.execute()
 pipeline.execute()  # Execute pipeline a second time
 ```
 
 When a system returns a dictionary, the keys of the dict are interpreted to be the names of the component variables to replace with the value of the respective key. So the final 2 systems in the Systems examples will replace the `result` field.
 
-Note that this helps us avoid having to pass parameters around, as it is done automatically for us, which cleans up the code base tremendously, as we have a concise pipeline definition, and when we call `Pipeline.execute`, we execute the 3 functions.
+Note that this helps us avoid having to pass parameters around, as it is done automatically for us, which cleans up the code base tremendously, as we have a concise pipeline definition, and when we call `Pipeline.execute`, we execute the 3 functions sequentially.
 
 ### Other handy tools
 
-`parse_arguments_cli` will read your argvs using argparse and give you a component object ready to use. So you may run your file like so: `file.py --args-files="file1.yaml,file2.yaml" --rest a=1 --rest b=2`. Consecutive files will overwrite the previous entries, and `--rest` take precendence always, but each `--rest` takes precedence over the previous.
+`parse_arguments_cli` will read your `argv`s using argparse and give you a component object ready to use. So you may run your file like so: `file.py --args-files="file1.yaml,file2.yaml" --rest a=1 -r b=2`. Consecutive files will overwrite the previous entries, and `--rest/-r` take precendence always, but each `--rest` takes precedence over the previous.
 
 * `--args-files` can be shortened to `-f`
 * `--rest` can be shortened to `-r`
 
 ## Some pattern ideas
 
 * Nested pipelines
+* Pipeline in loops
+
+# Example
+
+Look at and run `example.py` for better usage

examples/example.py

@@ -7,8 +7,7 @@
 
 import omegaconf
 
-from pcs.argument_parser import parse_arguments_cli
-from pcs.pipeline import Pipeline
+from pcs import Pipeline, parse_arguments_cli
 
 
 @dataclass

pcs/__init__.py

@@ -0,0 +1,21 @@
+from .argument_parser import (
+    do_parse_arguments,
+    parse_arguments_cli,
+    parse_arguments_from_files,
+    update_dict_with_comma_separated_file_list,
+    update_dict_with_files,
+)
+from .component import Component
+from .init import initialize_object_nones
+from .pipeline import Pipeline
+
+__all__ = [
+    "Component",
+    "Pipeline",
+    "do_parse_arguments",
+    "initialize_object_nones",
+    "parse_arguments_cli",
+    "parse_arguments_from_files",
+    "update_dict_with_comma_separated_file_list",
+    "update_dict_with_files",
+]

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pipeline-component-system"
-version = "0.4.5"
+version = "0.5.0"
 authors = [
   { name="Daniel Cauchi" },
 ]