Friday, August 18, 2017

Re: Best way to structure a django project with multiple levels of sub apps?



On Aug 17, 2017 2:26 PM, "Alexander Joseph" <alexander.v.joseph@gmail.com> wrote:

I'm bullding a larger django project and I'm starting to implement cookiecutter django after reading through "2 Scoops of Django" but still have some questions on structuring a project.


I've setup my project, we'll call it 'business_proj'. In business_proj I started an app called 'accounting' this might have an accounting dashboard for users in the accounting security group. Now, what if I want to have apps that belong to accounting, such as 'invoices' and 'purchase_orders'? Should I create those apps inside my accounting app? Or should I create all my apps in the main project root? The way I've started doing it is creating child apps inside of their parent apps but some parent apps are so big that even this gets messy. 


What you are calling 'apps', I would call models. PO's and invoices are part of larger workflows. There's no technical reason, or even from an organization perspective, to create that many apps.

<snip>

Is there a better way to do this? Or are there any pitfalls I need to watch out for doing it this way? Would it be better to simply make an 'engineering' folder (not module) in my project and store all the engineering related projects in that folder?Thanks

I think if you better define an app vs. a model, you'll find that you need only a few apps.

IMHO, an app should represent a logical segment of your project, broad enough that a majority of the business logic is self-contained and relies little on other apps. Apps should be very high level.

In your case, you would likely have apps for 'accounting' and 'engineering', along with other distinct units within the business. The business processes and logic for engineering have little or no overlap with that of accounting. Same with HR, IT, and so on. That's literally as detailed as your apps should be, in which case you'll probably end up with a dozen or so at worst. If it were me, I'd have even less than that with even larger groupings, maybe something along the lines of 'sales' and 'operations' as the only two apps.

One of the key ideas to help understand here is that a Python file containing models does not have to be called models.py. In fact, I usually don't have a models.py at all. Instead, I create a Python module within the app called 'models', which is nothing more than a directory named 'models' that contains __init__.py and all of the Python files that contains my models. Each of those files contains models that are further separated logically. The structure looks like this (some structure omitted for brevity):

business_proj/
    engineering/
        models/
            __init__.py
            abstract_design.py
            abstract_manufacturing.py
            abstract_quality_assurance.py
            design.py
            manufacturing.py
            quality_assurance.py

You could also bury the abstract models in their own module using the same pattern. 

Assuming you have 'engineering' as a registered app, your __init__.py would look

--
You received this message because you are subscribed to the Google Groups "Django users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-users+unsubscribe@googlegroups.com.
To post to this group, send email to django-users@googlegroups.com.
Visit this group at https://groups.google.com/group/django-users.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-users/CA%2Be%2BciWCagCYS6Rpp91uBiS2SbQzthJQ4kLObhrpHk30owN%2BfQ%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

No comments:

Post a Comment