mirror of
https://github.com/namibia/awesome-cheatsheets.git
synced 2024-11-16 01:57:10 +00:00
72 lines
4.6 KiB
Python
72 lines
4.6 KiB
Python
# *****************************************************************************
|
|
# CODING STYLE > MAKING YOUR CODE READABLE
|
|
# *****************************************************************************
|
|
|
|
|
|
# 1. Avoid abbreviating variable names.
|
|
# 2. Write out your function argument names.
|
|
# 3. Document your classes and methods.
|
|
# 4. Comment your code.
|
|
# 5. Refactor repeated lines of code into reusable functions or methods.
|
|
# 6. Keep functions and methods short. A good rule of thumb is that scrolling
|
|
# should not be necessary to read an entire function or method.
|
|
|
|
# TIP: Use Flake8 for Checking Code Quality.
|
|
|
|
|
|
# *****************************************************************************
|
|
# CODING STYLE > THE WORD ON IMPORTS
|
|
# *****************************************************************************
|
|
|
|
|
|
# Imports should be grouped in the following order:
|
|
|
|
# 1. Standard library imports.
|
|
# 2. Core Django imports.
|
|
# 3. Third-party app imports.
|
|
# 4. Imports from your apps.
|
|
|
|
# Use explicit relative imports.
|
|
# Avoid using import *
|
|
|
|
|
|
# *****************************************************************************
|
|
# CODING STYLE > OTHERS
|
|
# *****************************************************************************
|
|
|
|
|
|
# Use underscores in URL pattern names rather than dashes.
|
|
|
|
|
|
# *****************************************************************************
|
|
# DJANGO-ADMIN
|
|
# *****************************************************************************
|
|
|
|
|
|
django-admin startproject <ProjectName> # create a new project directory structure
|
|
django-admin startapp <Appname> # create a new django application with the specified name
|
|
django-admin migrate # synchronize the database state with your current state project models and migrations
|
|
django-admin makemigrations # create new migrations to the database based on the changes detected in the models
|
|
django-admin runserver # start the development webserver at 127.0.0.1 with the port 8000
|
|
django-admin help # display usage information and a list of the commands provided by each application
|
|
django-admin version # display the current django version
|
|
|
|
django-admin check # Checks the entire django project for potential problems
|
|
django-admin compilemessages # Compiles .po files to .mo files for use with builtin gettext support
|
|
django-admin createcachetable # Creates the tables needed to use the SQL cache backend.
|
|
django-admin dbshell # Runs the command-line client for specified database, or the default database if none is provided.
|
|
django-admin diffsettings # Displays differences between the current settings.py and Django's default settings.
|
|
django-admin dumpdata # Output the contents of the database as a fixture of the given format (using each model's default manager unless --all is specified).
|
|
django-admin flush # Removes ALL DATA from the database, including data added during migrations. Does not achieve a "fresh install" state.
|
|
django-admin inspectdb # Introspects the database tables in the given database and outputs a Django model module.
|
|
django-admin loaddata # Installs the named fixture(s) in the database.
|
|
django-admin makemessages # Runs over the entire source tree of the current directory and pulls out all strings marked for translation. It creates (or updates) a message file in the conf/locale (in the django tree) or locale (for projects and applications) directory. You must run this command with one of either the --locale, --exclude, or --all options.
|
|
django-admin sendtestemail # Sends a test email to the email addresses specified as arguments.
|
|
django-admin shell # Runs a Python interactive interpreter. Tries to use IPython or bpython, if one of them is available. Any standard input is executed as code.
|
|
django-admin showmigrations # Shows all available migrations for the current project.
|
|
django-admin sqlflush # Returns a list of the SQL statements required to return all tables in the database to the state they were in just after they were installed.
|
|
django-admin sqlmigrate # Prints the SQL statements for the named migration.
|
|
django-admin sqlsequencereset # Prints the SQL statements for resetting sequences for the given app name(s).
|
|
django-admin squashmigrations # Squashes an existing set of migrations (from first until specified) into a single new one.
|
|
django-admin testserver # Runs a development server with data from the given fixture(s).
|