src package structure?

[iyanmv]

Hi @mhostetter

What do you think about reorganizing the repo using a src structure? There are a few good reasons to do so.
Here are some refs that I found useful about this topic:

https://hynek.me/articles/testing-packaging/
pypa/packaging.python.org#320
https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure

Also, if you have some arguments in favor of current non src or flat structure, I would like to hear them.

I could work on a PR if you are interested.

[mhostetter]

Hey @iyanmv. I did a lot of reading about this today...

It seems to me the big advantage of using src/ is that when running python3 -m pytest tests/ in the root directory the local galois/ source code won't be imported (because we'd really prefer to import and test the installed package). Is that your understanding?

It looks like I ran into this a while ago and manually removed the galois/ folder and then installed the newly-created .whl.

galois/.github/workflows/test.yml

Lines 115 to 132 in 0ddcbd7

	- name: Remove source code
	uses: JesseTG/rm@v1.0.2
	with:
	path: galois/
	- name: Download wheel artifact
	uses: actions/download-artifact@v2
	with:
	name: dist
	path: dist/
	- name: Install package wheel
	run: |
	python3 -m pip install $(ls dist/galois-*.whl)
	- name: Test with pytest
	run: |
	python3 -m pytest tests/

It seems like the community consensus is around using src/, which works for me. I'm all about using the best thing™️ . From my reading, it also seems like pyproject.toml is preferred over setup.cfg. I'll have to do more research, but perhaps that could/should be changed in the future too.

Yeah, if you're up for a PR, that'd be great!

[mhostetter]

This was merged in #404.