Hello,

I am not sure if I looked into the correct sources. I was looking in
"PEP 609 – Python Packaging Authority (PyPA) Governance" [1] and the
"PyPA specifications" [2].

My question in short: Is there an official document (e.g. a PEP) about a recommended layout for project folders.

Looking into the wild and past there are a lot of variations of such
layouts. I am far away from being a pro but depending on experience in
my own projects and what I have learned from others (e.g. in blog-posts/tutorials) I recommend to have the "test" folder and the
package folder side by side on the same level in the project folder (the root).

my_project
|- tests
| └ test_*.py
|- my_package
| └ __init__.py
└-- README.md

I sometimes add to it the so called "src"-Layout where the package
folder is one level deeper in an extra "src" folder.

my_project
|- tests
| └ test_*.py
|- src
| └- my_package
| └ __init__.py
└-- README.md

I don't want to discuss the pros and cons of all variations. What I need
is an official document I can use in discussions with other maintainers.
If there is a PEP/document against my current recommendation I am also
fine with this. ;)

Kind
Christian

[1] -- <https://peps.python.org/pep-0609/>
[2] -- <https://packaging.python.org/en/latest/specifications>

--- SoupGate-Win32 v1.05
* Origin: fsxNet Usenet Gateway (21:1/5)

Isn't there a PEP?

On 2022-07-26 07:14 c.buhtz@posteo.jp wrote:

Hello,

I am not sure if I looked into the correct sources. I was looking in
"PEP 609 – Python Packaging Authority (PyPA) Governance" [1] and the
"PyPA specifications" [2].

My question in short: Is there an official document (e.g. a PEP)
about a recommended layout for project folders.

Looking into the wild and past there are a lot of variations of such layouts. I am far away from being a pro but depending on experience
in my own projects and what I have learned from others (e.g. in blog-posts/tutorials) I recommend to have the "test" folder and the
package folder side by side on the same level in the project folder
(the root).

my_project
|- tests
| └ test_*.py
|- my_package
| └ __init__.py
└-- README.md

I sometimes add to it the so called "src"-Layout where the package
folder is one level deeper in an extra "src" folder.

my_project
|- tests
| └ test_*.py
|- src
| └- my_package
| └ __init__.py
└-- README.md

I don't want to discuss the pros and cons of all variations. What I
need is an official document I can use in discussions with other
maintainers. If there is a PEP/document against my current
recommendation I am also fine with this. ;)

Kind
Christian

[1] -- <https://peps.python.org/pep-0609/>
[2] -- <https://packaging.python.org/en/latest/specifications>

--- SoupGate-Win32 v1.05
* Origin: fsxNet Usenet Gateway (21:1/5)

On 30 Jul 2022, at 13:52, c.buhtz@posteo.jp wrote:

Isn't there a PEP?

PEP are for improving python. They are not for telling people how to use python.
I would be surprised to fine a PEP that addressed this.

Barry

On 2022-07-26 07:14 c.buhtz@posteo.jp wrote:
Hello,

I am not sure if I looked into the correct sources. I was looking in
"PEP 609 – Python Packaging Authority (PyPA) Governance" [1] and the
"PyPA specifications" [2].

My question in short: Is there an official document (e.g. a PEP)
about a recommended layout for project folders.

Looking into the wild and past there are a lot of variations of such
layouts. I am far away from being a pro but depending on experience
in my own projects and what I have learned from others (e.g. in
blog-posts/tutorials) I recommend to have the "test" folder and the
package folder side by side on the same level in the project folder
(the root).

my_project
|- tests
| └ test_*.py
|- my_package
| └ __init__.py
└-- README.md

I sometimes add to it the so called "src"-Layout where the package
folder is one level deeper in an extra "src" folder.

my_project
|- tests
| └ test_*.py
|- src
| └- my_package
| └ __init__.py
└-- README.md

I don't want to discuss the pros and cons of all variations. What I
need is an official document I can use in discussions with other
maintainers. If there is a PEP/document against my current
recommendation I am also fine with this. ;)

Kind
Christian

[1] -- <https://peps.python.org/pep-0609/>
[2] -- <https://packaging.python.org/en/latest/specifications>

--
https://mail.python.org/mailman/listinfo/python-list

--- SoupGate-Win32 v1.05
* Origin: fsxNet Usenet Gateway (21:1/5)

On Sun, 31 Jul 2022 at 20:27, Weatherby,Gerard <gweatherby@uchc.edu> wrote:

I’m not aware of any standard convention for laying out packages.

PEP 8 (https://peps.python.org/pep-0008/) specifies conventions for how to write Python, so a standard layout PEP would not be inconsistent.

PEP 8 species rules for laying out the code of the Python standard
library. Its adoption by other projects does not constitute the Python developers declaring that it's a convention for how to write all
Python code.

A better example would be PEP 257 https://peps.python.org/pep-0257/
but even that is more for the purpose of tooling. It does at least try
to describe usage conventions, though.

Conventions for laying out packages (as opposed to actual requirements
defined by the packaging system itself) would be better described
somewhere other than a PEP.

ChrisA

--- SoupGate-Win32 v1.05
* Origin: fsxNet Usenet Gateway (21:1/5)

SeKAmW0gbm90IGF3YXJlIG9mIGFueSBzdGFuZGFyZCBjb252ZW50aW9uIGZvciBsYXlpbmcgb3V0 IHBhY2thZ2VzLg0KDQpQRVAgOCAoaHR0cHM6Ly9wZXBzLnB5dGhvbi5vcmcvcGVwLTAwMDgvKSBz cGVjaWZpZXMgY29udmVudGlvbnMgZm9yIGhvdyB0byB3cml0ZSBQeXRob24sIHNvIGEgc3RhbmRh cmQgbGF5b3V0IFBFUCB3b3VsZCBub3QgYmUgaW5jb25zaXN0ZW50Lg0KDQrigJQNCkdlcmFyZCBX ZWF0aGVyYnkgfCBBcHBsaWNhdGlvbiBBcmNoaXRlY3QgTk1SYm94IHwgTkFOIHwgRGVwYXJ0bWVu dCBvZiBNb2xlY3VsYXIgQmlvbG9neSBhbmQgQmlvcGh5c2ljcw0KIFVDb25uIEhlYWx0aCAyNjMg RmFybWluZ3RvbiBBdmVudWUsIEZhcm1pbmd0b24sIENUIDA2MDMwLTY0MDYgdWNoYy5lZHUNCk9u IEp1bCAzMCwgMjAyMiwgNDozNyBQTSAtMDQwMCwgQmFycnkgPGJhcnJ5QGJhcnJ5cy1lbWFjcy5v cmc+LCB3cm90ZToNCioqKiBBdHRlbnRpb246IFRoaXMgaXMgYW4gZXh0ZXJuYWwgZW1haWwuIFVz ZSBjYXV0aW9uIHJlc3BvbmRpbmcsIG9wZW5pbmcgYXR0YWNobWVudHMgb3IgY2xpY2tpbmcgb24g bGlua3MuICoqKg0KDQpPbiAzMCBKdWwgMjAyMiwgYXQgMTM6NTIsIGMuYnVodHpAcG9zdGVvLmpw IHdyb3RlOg0KDQrvu79Jc24ndCB0aGVyZSBhIFBFUD8NCg0KUEVQIGFyZSBmb3IgaW1wcm92aW5n IHB5dGhvbi4gVGhleSBhcmUgbm90IGZvciB0ZWxsaW5nIHBlb3BsZSBob3cgdG8gdXNlIHB5dGhv bi4NCkkgd291bGQgYmUgc3VycHJpc2VkIHRvIGZpbmUgYSBQRVAgdGhhdCBhZGRyZXNzZWQgdGhp cy4NCg0KQmFycnkNCg0KDQpPbiAyMDIyLTA3LTI2IDA3OjE0IGMuYnVodHpAcG9zdGVvLmpwIHdy b3RlOg0KSGVsbG8sDQoNCkkgYW0gbm90IHN1cmUgaWYgSSBsb29rZWQgaW50byB0aGUgY29ycmVj dCBzb3VyY2VzLiBJIHdhcyBsb29raW5nIGluDQoiUEVQIDYwOSDigJMgUHl0aG9uIFBhY2thZ2lu ZyBBdXRob3JpdHkgKFB5UEEpIEdvdmVybmFuY2UiIFsxXSBhbmQgdGhlDQoiUHlQQSBzcGVjaWZp Y2F0aW9ucyIgWzJdLg0KDQpNeSBxdWVzdGlvbiBpbiBzaG9ydDogSXMgdGhlcmUgYW4gb2ZmaWNp YWwgZG9jdW1lbnQgKGUuZy4gYSBQRVApDQphYm91dCBhIHJlY29tbWVuZGVkIGxheW91dCBmb3Ig cHJvamVjdCBmb2xkZXJzLg0KDQpMb29raW5nIGludG8gdGhlIHdpbGQgYW5kIHBhc3QgdGhlcmUg YXJlIGEgbG90IG9mIHZhcmlhdGlvbnMgb2Ygc3VjaA0KbGF5b3V0cy4gSSBhbSBmYXIgYXdheSBm cm9tIGJlaW5nIGEgcHJvIGJ1dCBkZXBlbmRpbmcgb24gZXhwZXJpZW5jZQ0KaW4gbXkgb3duIHBy b2plY3RzIGFuZCB3aGF0IEkgaGF2ZSBsZWFybmVkIGZyb20gb3RoZXJzIChlLmcuIGluDQpibG9n LXBvc3RzL3R1dG9yaWFscykgSSByZWNvbW1lbmQgdG8gaGF2ZSB0aGUgInRlc3QiIGZvbGRlciBh bmQgdGhlDQpwYWNrYWdlIGZvbGRlciBzaWRlIGJ5IHNpZGUgb24gdGhlIHNhbWUgbGV2ZWwgaW4g dGhlIHByb2plY3QgZm9sZGVyDQoodGhlIHJvb3QpLg0KDQpteV9wcm9qZWN0DQp8LSB0ZXN0cw0K fCDilJQgdGVzdF8qLnB5DQp8LSBteV9wYWNrYWdlDQp8IOKUlCBfX2luaXRfXy5weQ0K4pSULS0g UkVBRE1FLm1kDQoNCkkgc29tZXRpbWVzIGFkZCB0byBpdCB0aGUgc28gY2FsbGVkICJzcmMiLUxh eW91dCB3aGVyZSB0aGUgcGFja2FnZQ0KZm9sZGVyIGlzIG9uZSBsZXZlbCBkZWVwZXIgaW4gYW4g ZXh0cmEgInNyYyIgZm9sZGVyLg0KDQpteV9wcm9qZWN0DQp8LSB0ZXN0cw0KfCDilJQgdGVzdF8q LnB5DQp8LSBzcmMNCnwg4pSULSBteV9wYWNrYWdlDQp8IOKUlCBfX2luaXRfXy5weQ0K4pSULS0g UkVBRE1FLm1kDQoNCkkgZG9uJ3Qgd2FudCB0byBkaXNjdXNzIHRoZSBwcm9zIGFuZCBjb25zIG9m IGFsbCB2YXJpYXRpb25zLiBXaGF0IEkNCm5lZWQgaXMgYW4gb2ZmaWNpYWwgZG9jdW1lbnQgSSBj YW4gdXNlIGluIGRpc2N1c3Npb25zIHdpdGggb3RoZXINCm1haW50YWluZXJzLiBJZiB0aGVyZSBp cyBhIFBFUC9kb2N1bWVudCBhZ2FpbnN0IG15IGN1cnJlbnQNCnJlY29tbWVuZGF0aW9uIEkgYW0g YWxzbyBmaW5lIHdpdGggdGhpcy4gOykNCg0KS2luZA0KQ2hyaXN0aWFuDQoNClsxXSAtLSA8aHR0 cHM6Ly91cmxkZWZlbnNlLmNvbS92My9fX2h0dHBzOi8vcGVwcy5weXRob24ub3JnL3BlcC0wNjA5 L19fOyEhQ25fVVhfcDMhaXBxU1FTNV9aRnhPMzdoNWg1WEFMZjJEeEUzZVYteDZxTlNyVm5LSlUz Y0xaSWtMZktodVR6U3hpMWZiLUJ2WU5WUFhlVC1uWUZYOG9ndTZCTHVKakEkID4NClsyXSAtLSA8 aHR0cHM6Ly91cmxkZWZlbnNlLmNvbS92My9fX2h0dHBzOi8vcGFja2FnaW5nLnB5dGhvbi5vcmcv ZW4vbGF0ZXN0L3NwZWNpZmljYXRpb25zX187ISFDbl9VWF9wMyFpcHFTUVM1X1pGeE8zN2g1aDVY QUxmMkR4RTNlVi14NnFOU3JWbktKVTNjTFpJa0xmS2h1VHpTeGkxZmItQnZZTlZQWGVULW5ZRlg4 b2d1eWpiZzE1ZyQgPg0KDQotLQ0KaHR0cHM6Ly91cmxkZWZlbnNlLmNvbS92My9fX2h0dHBzOi8v bWFpbC5weXRob24ub3JnL21haWxtYW4vbGlzdGluZm8vcHl0aG9uLWxpc3RfXzshIUNuX1VYX3Az IWlwcVNRUzVfWkZ4TzM3aDVoNVhBTGYyRHhFM2VWLXg2cU5TclZuS0pVM2NMWklrTGZLaHVUelN4 aTFmYi1CdllOVlBYZVQtbllGWDhvZ3NlNl9KMkhnJA0KDQotLQ0KaHR0cHM6Ly91cmxkZWZlbnNl LmNvbS92My9fX2h0dHBzOi8vbWFpbC5weXRob24ub3JnL21haWxtYW4vbGlzdGluZm8vcHl0aG9u LWxpc3RfXzshIUNuX1VYX3AzIWlwcVNRUzVfWkZ4TzM3aDVoNVhBTGYyRHhFM2VWLXg2cU5TclZu S0pVM2NMWklrTGZLaHVUelN4aTFmYi1CdllOVlBYZVQtbllGWDhvZ3NlNl9KMkhnJA0K

--- SoupGate-Win32 v1.05
* Origin: fsxNet Usenet Gateway (21:1/5)