[Django]-Is there a naming convention for Django apps

179๐Ÿ‘

โœ…

They must be valid package names. That rules out 2 (โ€œimport my-django-appโ€ would be a syntax error). PEP 8 says:

Modules should have short, all-lowercase names. Underscores can be used
in the module name if it improves readability. Python packages should
also have short, all-lowercase names, although the use of underscores is
discouraged.

So, 1 and 3 are both valid, but 3 would be the recommended approach.

40๐Ÿ‘

some good examples

  • graphene_django
  • users
  • orders
  • oauth2_provider
  • rest_framework
  • polls

in simple terms, app_name should have short, all-lowercase names. Underscores can be used in the module name if it improves readability. also should have a short name and it can be a plural and singular name

9๐Ÿ‘

App directory names must be a valid Python package name. This means that option 2 is completely inadmissible as a package name, although it can still be used for other purposes, such as documentation. In the end it comes down to personal style. If you prefer option 3 then use it.

0๐Ÿ‘

My votes for 1 and 3, but you can check several popular apps:
http://www.django-cms.org/
http://geodjango.org/

Leave a comment