Added example pyproject and package.

[MicahGale]

Added an example package with a pyproject.toml file.

This a variety of levels of concepts that may or not be appropriate for this scope.

1. a pyproject.toml file that covers:
   1. base metadata
   2. dependencies
   3. setuptools/build metadata: python -m build and pip install . should work on it.
   4. Configuring third-party plugins (pytest).
   5. Specifying optional dependencies
2. Packaging covering:
   1. having an __init__.py
   2. Importing a class to be top-level from a submodule
   3. Making the module executable via __main__.py
   4. Internal package imports
   5. Testing a package
3. OOP:
   1. Using _private
   2. Making @property getters
   3. Doc strings with sphinx directives
4. Testing:
   1. Structure and imports
   2. pytest.fixture
   3. Using pytest.approx for float comparisons
5. Amusing myself.

Fixes #3.

[gonuke]

Can we implement this on the files in #1 (and thus merge that ASAP if ready) including moving those files as appropriate?

[MicahGale]

Yes, I was thinking this should be based on #1, but I didn't want to deal with a second remote. So I'll make this a draft again until that is merged.

Can we implement this on the files in #1 (and thus merge that ASAP if ready) including moving those files as appropriate?

By this do you mean moving the current files in #1 into the package or not? I was thinking of including some top level files that show good practices for scripting, and then this being an independent-ish folder and showing packaging.

[gonuke]

Can we implement this on the files in #1 (and thus merge that ASAP if ready) including moving those files as appropriate?

By this do you mean moving the current files in #1 into the package or not? I was thinking of including some top level files that show good practices for scripting, and then this being an independent-ish folder and showing packaging.

I guess I don't need to get too complicated. It's meant for people starting new projects from scratch without a lot of prior experience. Happy to debate what that minimal case looks like, so I'll see how it all fits. Don't want you to go too far down a rabbit hole though.

[MicahGale]

Add example of pyproject scripts/entry points?

[MicahGale]

Todo: move do_task.py and test_do_task.py into acme_corp. Harmonize doc strings.

[gonuke]

A couple of typos and reminder about docstring format.

[gonuke]

did we decide to switch to numpy docstring style?

[MicahGale]

I think we decided to make that a separate PR #12.

[gonuke]

Is this file necessary?

[MicahGale]

Pytest isn't happy without it. I can't remember if python has removed the need for this file or not. There might be a workaround, but I'm thinking: "if it ain't broke..."

========================================================================= test session starts ==========================================================================
platform linux -- Python 3.10.13, pytest-7.4.0, pluggy-1.3.0
rootdir: /home/mgale/dev/py-template
plugins: anyio-4.0.0, profiling-1.7.0
collected 0 items / 2 errors

================================================================================ ERRORS ================================================================================
________________________________________________________________ ERROR collecting tests/test_do_task.py ________________________________________________________________
ImportError while importing test module '/home/mgale/dev/py-template/tests/test_do_task.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
../../mambaforge/lib/python3.10/importlib/__init__.py:126: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests/test_do_task.py:1: in <module>
    import acme_corp.do_task as do_task
E   ModuleNotFoundError: No module named 'acme_corp'
_________________________________________________________________ ERROR collecting tests/test_piano.py _________________________________________________________________
ImportError while importing test module '/home/mgale/dev/py-template/tests/test_piano.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
../../mambaforge/lib/python3.10/importlib/__init__.py:126: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests/test_piano.py:1: in <module>
    import acme_corp
E   ModuleNotFoundError: No module named 'acme_corp'
======================================================================= short test summary info ========================================================================
ERROR tests/test_do_task.py
ERROR tests/test_piano.py
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Interrupted: 2 errors during collection !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
========================================================================== 2 errors in 0.11s ===========================================================================

[gonuke]

Thanks @MicahGale