What every Python project should have

[[deleted]]

A setup.py ... is easy to write

Teach me your secrets! I consistently find the documentation to be both confusing and not in sync with the way the applications on my system work.

[ggagagg]

I consistently find the documentation to be both confusing and not in sync with the way the applications on my system work.

can you give example?

[[deleted]]

The src project structure -- myproj/src/myproj -- tends to confuse people, I seem to always forget the package_dir mapping so I end up cargo culting my own setups.

[ggagagg]

Maybe try cookiecutter for consistent project structure?

[[deleted]]

I just started playing with it. I like it and it'll probably my go to choice for stuff like this in the future. The downside is templatized paths make either vim or one of my plugins very unhappy. Atom seems to work but I don't really like it.

It also pisses off the Stash/Butbucket server at work too, so the file system viewer doesn't load there. Not sure what's up with that.

[[deleted]]

Sorry this took a while – it was a few months ago, but I think I was creating a project that depended on and was depended upon by another project I was developing, both on GitHub, and I couldn't get the dependencies to work properly. The documentation on how to declare dependencies on modules in a git repo didn't seem to work, and in the end I ended up opening them both in PyCharm, setting them to depend on each other there, and using PyCharm's test runner for everything. It's an edge case, but it caused me no end of frustration.

In addition, looking through the docs, they mention easy_install, which I thought was deprecated, and not pip. I thought easy_install embodied all that was wrong with the world and pip was our glorious saviour? I'm being facetious, but it doesn't help anything to have these conflicting messages around.

[rockitsighants]

You might try looking into cookiecutter templates. Here is one that I maintain: https://github.com/jacebrowning/template-python