Changes before Open Sourcing

[derekmiddlemiss]

Definite

• Rename (xparams.org exists; probably easier to avoid). Provisionally, xparams.XParams -> tomlparams.TOMLParams).
• Check examples are OK/sufficient (and update to reflect new name)
• (Significantly) expand README.md
• Expand key docstrings, particularly XParams itself (meaning of arguments)
• Get confirmation from management that license is OK and that they are generally bought in.
• Edit License to say refer to Smart Data Foundry as copyright holder, rather than GOFCoE.
• Create a smartdatafoundry account on PyPI and TestPyPI (and readthedocs, I suppose).
• Submit to testpypi before PyPI and check it all looks and works OK from there.
• Check poetry.lock, which looks like it has way more than it needs in it, and also pyproject.toml, which might have more than it needs.
• Change IGNORE to OFF for type checking (enumeration and value for TOMLPARAMSCHECKING environment variable.
• Decide the release version number and also consider using a hook or similar to update the version number. Or maybe just a script to do it (basically bump version)

Possible

• Be able to pass defaults in as a TOML itself — if defaults param is a string, interpret it as the name of TOML to load from.
• Be able to indicate to XParams just to go ahead with run with defaults only, i.e. don't look for an overwrite TOML to use (avoids need to create an empty TOML just to get stuff to run, which is possibly a bit of a pain). Perhaps could be invoked on passing in 'defaults' to the name param?
• Allow dict-style lookup of parameters in p of type XParams (p['foo'] as well as object style lookup (p.foo). We already had this for ParamGroups, but not for XParams itself (the top level).
• Create doc directly with Sphinx + MyST structure and (for now) just copy the README.md in.
• Rename the GitHub organization to smartdatafoundry before open sourcing (so the source URL doesn't change).