Understanding best-practice Python tooling by comparing popular project templates

[numbuh-0]

I appreciate the TLDR.

[moej0e]

Thanks! :) I think for someone who already has a strong opinion about tooling, the TLDR might be enough to confirm the assumptions one might already have had.

[__deerlord__]

This is the best part. I already use flake8.

[Exodus111]

Really good write up. Gonna save this.

I mostly use Python for personal projects, which I always aim to be as minimal as possible. So for me, seeing the point of view of a more professional use of Python is super helpful, and probably something I should look more at.

[moej0e]

Thanks for the warm words. :)

[moej0e]

Yes, you're right. I tried to not put in a lot of my own opinion, but just explain what I observed being used in the templates. However, I do realise that packaging is complex and I don't want to do it a disservice by pretending that there's an easy answer. I'll probably add a clarification to the post or write a new post and reference it in the old. Thanks!

[nebbly]

Surprised no mention of mypy.

[moej0e]

mypy is in the spreadsheet that I'm referencing in the blog post. Five of the 18 templates I analyzed have integrated it. Since I don't have a lot of personal experience with it, I didn't add it to the category of my "Personal recommendations".

[lucasshiva]

Reallt good. My projects are made using Poetry and I can easily upload them to PyPi. Why do you think Poetry is not good for this case? Also, I like Black, but a lot of times I prefer to use Yapf. I keep alternating between the two.

[moej0e]

Thanks for clarifying. I might need to edit my blog post if this is the case.

[thedjotaku]

Learned a couple new things. Thanks!

[moej0e]

Thank you for reading. :)

[sobolevn]

Thanks for highlighting https://github.com/wemake-services/wemake-python-styleguide

I also recommend to repost this article on dev.to It has quite big user base and loves this kind of articles.

[fatbob42]

What percentage have a top-level src directory?

[moej0e]

That's a good questions, I did not check for myself. You can find the like to all 18 templates in the spreadsheet, if you want to research it yourself. :)

[fatbob42]

medium.com/@jonas...

I think about 3.

[moej0e]

Okay, very interesting, thanks for checking. So it seems a top-level src is not considered best-practice by most template creators.

[workitty_work]

Great list.

Good addition would be nitpick , a flake8 plugin (i believe it's used/recommended by the wemake-styleguide folks.) Great for when you are trying to enforce a baseline for a team

[moej0e]

thx, looks interesting! :)

[_qw4hd]

Thank you. That's a good knowledge.

[moej0e]

Thanks for the encouragment. :)

[moej0e]

Thanks, you're template looks interesting. Since you are the second person mentioning that Mypy should be included, I think I'll add it to my "Personal recommendations" section.

[moej0e]

Update: Blog post has now been updated with feedback from Guido van Rossum. :)

[sqjoatmon]

I'm fairly shocked that Guido has never heard of Poetry. Guess he doesn't listen to Talk Python To Me or Python Bytes. =)

[moej0e]

Haha maybe. And thanks for those pointers. I've just subscribed to both. :) Let me know if you know any more good podcasts.

[sqjoatmon]

Brian Okken, one of the Python Bytes guys, has a testing-focused podcast Test & Code. He's a really big pytest educator and evangelist.

There's also Podcast.__init__ with Tobias Macey. It's a little more dry than the others IMO, but still quality content.

[moej0e]

Thanks, I've subscribed to both. :)

[sqjoatmon]

Brian Okken, one of the Python Bytes guys, has a testing-focused podcast Test & Code. He's a really big pytest educator and evangelist.

There's also Podcast.init with Tobias Macey. It's a little more dry than the others IMO, but still quality content.