Cookiecutter-django: Typical place to create app in cookiecutter-django

[playma]

I have a question.
Startapp creates the app in the first level, the same directory where manage.py is.
Why not create the app in the / level, where also the users app is?

[ahhda]

I think this has been tried before (See #1725 ). The django startapp, apparently, was not projected to be extended.

[playma]

@ahhda Thank you for your reply, but I just want to check where should I create the app (in the first level or second level). #1725 only discussed how to move the app from the first level to the second level.

[ahhda]

@playma cookiecutter-django defines apps inside project folder.
Therefore the canonical place is inside the the project folder (second level), otherwise the root folder gets littered with too much stuff.

[webyneter]

Yes, the second level is the right place for your Django apps.
FWIW, I personally do not use the srartapp command, and just create a Django package with apps.py myself, as well as reference it in settings. This is what a typical apps.py looks like for me (and I don't even have to write the most part of it since I have it generated from a PyCharm Live Template of mine):

# apps.py in your new shiny Django app under the project's root `<project_slug>/` dir

from django.apps import AppConfig
from django.utils.translation import ugettext_lazy as _


class <YourCamelCaseAppName>AppConfig(AppConfig):
    name = "<project_slug>.<your_snake_case_app_name>"
    verbose_name = _("<Your app brand name>")

    def ready(self):
        try:
            # noinspection PyUnresolvedReferences
            from . import signals  # noqa F401
        except ImportError:
            pass

And this where you should install your new app:

# `base.py`

# ...
LOCAL_APPS = [
    # ...
    "<project_slug>.<your_snake_case_app_name>.apps.<YourCamelCaseAppName>AppConfig",
    # ...
]
# ...

Should you need that specific app installed in some specific environment only, provided that environment has an associated settings file like local.py or production.py:

# anywhere else but in `base.py`

# ...
INSTALLED_APPS += ["<project_slug>.<your_snake_case_app_name>.apps.<YourCamelCaseAppName>AppConfig"]
# ...

[reyesvicente]

Hi, does this mean we don't need to include the new app on the urls.py?

[webyneter]

It depends: if your app contains urls you'd like to expose to the outer world then you gotta include those urls from the root urls.py via include.

[reyesvicente]

Thats weird. I tried to include it but it doesn't recognize my app and returns ModuleNotFoundError: No module named '<project_slug>.<app_name>.urls'

[webyneter]

If your app contains models did you install it into INSTALLED_APPS?

[reyesvicente]

Yes, I followed the instructions here. :smile:

[reyesvicente]

[webyneter]

Try including the app under a different root, like "pages/" rather than""`

[webyneter]

Also, did you specify app_name="pages" in icvn/pages/urls.py?

[reyesvicente]

Also, did you specify app_name="pages" in icvn/pages/urls.py?

Yes I did. I followed what was here on this comment on this thread.

I tried also including pages/ on the urls.py but it didn't work

[reyesvicente]

This is my apps.py

from django.apps import AppConfig
from django.utils.translation import ugettext_lazy as _


class PagesConfig(AppConfig):
    name = "icvn.pages"
    verbose_name = _("Pages")

    def ready(self):
        try:
            from . import signals
        except ImportError:
            pass

[webyneter]

Hm, then, I can't say for sure what's wrong without inspecting the code base first. My email is posted on my github profile, feel free to reach out.

[reyesvicente]

Hm, then, I can't say for sure what's wrong without inspecting the code base first. My email is posted on my github profile, feel free to reach out.

Cool. I just sent an email.

[webyneter]

@reyesvicente I'll get back to you by the end of the weekend.

[reyesvicente]

@reyesvicente I'll get back to you by the end of the weekend.

Thanks!

[webyneter]

@reyesvicente you don't actually have icvn,pages.urls module, hence the error. An empty one would suffice, for instance:

# icvn/pages/urls.py

app_name = "pages"
urlpatterns = [
]

You may also replace the config/urls.py path("pages/", include('icvn.pages.urls', namespace='pages')), line with just path("pages/", include('icvn.pages.urls')),, just make sure to specify app_name in the referenced routes file.

[reyesvicente]

@reyesvicente you don't actually have icvn,pages.urls module, hence the error. An empty one would suffice, for instance:

# icvn/pages/urls.py

app_name = "pages"
urlpatterns = [
]

You may also replace the config/urls.py path("pages/", include('icvn.pages.urls', namespace='pages')), line with just path("pages/", include('icvn.pages.urls')),, just make sure to specify app_name in the referenced routes file.

It worked! Thank you!