Question

Yesterday I started an important Python project and since then I've been searching for documentation on how to organize the code to have a "high-quality" project. There is a lot of articles and official documentation about how to organize packages and modules but, as I'm very new to this language, I think that is not my case.

The project is a client-server platform to distribute files in a local network (ok, is a lot more than this but its the basic idea). The thing is that is not going to be a module and I think that is not a package. At least not as described in the Python documentation:

Packages are a way of structuring Python’s module namespace by using “dotted module names”

I searched too in Git to see what popular project do to organize its code but most of them are modules and the rest... I don't even know how to run them.

So the question is, what is my code (module, package, ...) and which is the best way to organize it? Do you know any good article about this?

Thank you.

Was it helpful?

Solution

Yes, your project will be a package.

A module is a collection of related code. Most non-trivial projects will be a collection of modules in a package (potentially with sub-packages).

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top