And the workflows must also be updated to use higher versions of python and poetry (I will also create a separate issue for these). but putting here for completeness
upgraded actions/checkout@v4 and actions/setup-python@v5
the use of poetry
4. Add a dummy test (to avoid failing github CI out of the box)
Finally, (I will also create a separate issue for this), we should add test_dummy for all new projects. Otherwise the default workflow will fail because it isn't able to find any tests.
So test_<repo_name> would now be something like
#!/usr/bin/env python
"""test_nanoplot.py - auto-generated by softnanotools"""
from softnanotools.logger import Logger
logger = Logger(__name__)
def test_dummy():
"""
>>> assert 1 == 1
"""
logger.info("Dummy test passed")
if __name__ == '__main__':
import doctest
doctest.testmod()
Summary
I'd love to have a different (and simpler - i.e. less files) project template with
softnanotools.generate
Different Changes
1. Tree
It would follow a tree structure like so:
Also, what might be your thoughts on doing
./src/<repository_name>
instead of./<repository_name>
?2.
pyproject.toml
Where pyproject.toml looks something like:
3.
.github/workflows/<>
And the workflows must also be updated to use higher versions of python and poetry (I will also create a separate issue for these). but putting here for completeness
Updated workflows should look like:
coverage.yml
quick-build.yml
Above: note the changes in 2 things
actions/checkout@v4
andactions/setup-python@v5
poetry
4. Add a dummy test (to avoid failing github CI out of the box)
Finally, (I will also create a separate issue for this), we should add
test_dummy
for all new projects. Otherwise the default workflow will fail because it isn't able to find any tests.So
test_<repo_name>
would now be something like