Merge remote-tracking branch 'origin/master' into exclude-projects

Author: ericholscher

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+ignore = E125,D100,D101,D102,D105,D107,D200,D211,P101,FI15,FI16,FI12,FI11,FI17,FI50,FI53,FI54,T000,MQ101
+max-line-length = 80

.gitignore

@@ -15,6 +15,7 @@
 .ropeproject/
 _build
 bower_components/
+contrib/supervisord.log
 deploy/.vagrant
 dist/*
 local_settings.py
@@ -42,3 +43,5 @@ private_*
 .rope_project/
 readthedocs/htmlcov
 tags
+.python-version
+*.pyo

.isort.cfg

@@ -0,0 +1,9 @@
+[settings]
+line_length=80
+indent='    '
+multi_line_output=4
+default_section=THIRDPARTY
+known_first_party=readthedocs,readthedocsinc
+known_third_party=mock
+sections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
+add_imports=from __future__ import division, from __future__ import print_function, from __future__ import unicode_literals

.pep8

@@ -0,0 +1,3 @@
+[pep8]
+ignore = E701,E70,E702
+max-line-length = 80

.pre-commit-config.yaml

@@ -0,0 +1,62 @@
+exclude: '^$'
+fail_fast: false
+repos:
+- repo: [email protected]:pre-commit/pre-commit-hooks
+  sha: v1.1.1
+  hooks:
+    - id: autopep8-wrapper
+    - id: check-added-large-files
+    - id: debug-statements
+    - id: double-quote-string-fixer
+    - id: end-of-file-fixer
+    - id: fix-encoding-pragma
+    - id: flake8
+      additional_dependencies: [
+      'flake8-blind-except',
+      'flake8-coding',
+      'flake8-comprehensions',
+      'flake8-debugger',
+      'flake8-deprecated',
+      'flake8-docstrings',
+      'flake8-meiqia',
+      'flake8-mutable',
+      'flake8-pep3101',
+      'flake8-print',
+      'flake8-quotes',
+      'flake8-string-format',
+      'flake8-tidy-imports',
+      'flake8-todo']
+    - id: trailing-whitespace
+
+- repo: [email protected]:pre-commit/mirrors-yapf.git
+  sha: v0.20.0
+  hooks:
+    - id: yapf
+      exclude: 'migrations|settings|scripts'
+      additional_dependencies: ['futures']
+
+- repo: [email protected]:FalconSocial/pre-commit-python-sorter.git
+  sha: b57843b0b874df1d16eb0bef00b868792cb245c2
+  hooks:
+    - id: python-import-sorter
+      args: ['--silent-overwrite']
+
+- repo: [email protected]:humitos/mirrors-docformatter.git
+  sha: v0.8
+  hooks:
+    - id: docformatter
+      args: ['--in-place', '--wrap-summaries=80', '--wrap-descriptions=80', '--pre-summary-newline', '--no-blank']
+
+- repo: [email protected]:humitos/mirrors-autoflake.git
+  sha: v1.0
+  hooks:
+    - id: autoflake
+      args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variable']
+
+- repo: git://github.com/guykisel/prospector-mirror
+  sha: 'b27f281eb9398fc8504415d7fbdabf119ea8c5e1'
+  hooks:
+    - id: prospector
+      # https://github.com/pre-commit/pre-commit/issues/178
+      language: system
+      args: ['--profile=prospector']

.style.yapf

@@ -0,0 +1,203 @@
+# https://github.com/google/yapf
+# current version used in this repo
+# yapf==0.20.0
+
+
+[style]
+# Align closing bracket with visual indentation.
+ALIGN_CLOSING_BRACKET_WITH_VISUAL_INDENT=True
+
+# Allow lambdas to be formatted on more than one line.
+ALLOW_MULTILINE_LAMBDAS=False
+
+# Allow dictionary keys to exist on multiple lines. For example:
+#
+# x = {
+#     ('this is the first element of a tuple',
+#      'this is the second element of a tuple'):
+#          value,
+# }
+ALLOW_MULTILINE_DICTIONARY_KEYS=False
+
+# Insert a blank line before a 'def' or 'class' immediately nested
+# within another 'def' or 'class'. For example:
+#
+#   class Foo:
+#                      # <------ this blank line
+#     def method():
+#       ...
+BLANK_LINE_BEFORE_NESTED_CLASS_OR_DEF=True
+
+# Insert a blank line before a class-level docstring.
+BLANK_LINE_BEFORE_CLASS_DOCSTRING=True
+
+# Do not split consecutive brackets. Only relevant when
+# dedent_closing_brackets is set. For example:
+#
+#    call_func_that_takes_a_dict(
+#        {
+#            'key1': 'value1',
+#            'key2': 'value2',
+#        }
+#    )
+#
+# would reformat to:
+#
+#    call_func_that_takes_a_dict({
+#        'key1': 'value1',
+#        'key2': 'value2',
+#    })
+COALESCE_BRACKETS=True
+
+# The column limit.
+COLUMN_LIMIT=80
+
+# Indent width used for line continuations.
+CONTINUATION_INDENT_WIDTH=4
+
+# Put closing brackets on a separate line, dedented, if the bracketed
+# expression can't fit in a single line. Applies to all kinds of
+# brackets, including function definitions and calls. For example:
+#
+#   config = {
+#       'key1': 'value1',
+#       'key2': 'value2',
+#   }        # <--- this bracket is dedented and on a separate line
+#
+#   time_series = self.remote_client.query_entity_counters(
+#       entity='dev3246.region1',
+#       key='dns.query_latency_tcp',
+#       transform=Transformation.AVERAGE(window=timedelta(seconds=60)),
+#       start_ts=now()-timedelta(days=3),
+#       end_ts=now(),
+#   )        # <--- this bracket is dedented and on a separate line
+DEDENT_CLOSING_BRACKETS=False
+
+# Place each dictionary entry onto its own line.
+EACH_DICT_ENTRY_ON_SEPARATE_LINE=False
+
+# The regex for an i18n comment. The presence of this comment stops
+# reformatting of that line, because the comments are required to be
+# next to the string they translate.
+I18N_COMMENT=
+
+# The i18n function call names. The presence of this function stops
+# reformattting on that line, because the string it has cannot be moved
+# away from the i18n comment.
+I18N_FUNCTION_CALL=["_", "ugettext", "gettext"]
+
+# Indent the dictionary value if it cannot fit on the same line as the
+# dictionary key. For example:
+#
+#   config = {
+#       'key1':
+#           'value1',
+#       'key2': value1 +
+#               value2,
+#   }
+INDENT_DICTIONARY_VALUE=False
+
+# The number of columns to use for indentation.
+INDENT_WIDTH=4
+
+# Join short lines into one line. E.g., single line 'if' statements.
+JOIN_MULTIPLE_LINES=True
+
+# Use spaces around the power operator.
+SPACES_AROUND_POWER_OPERATOR=True
+
+# Do not include spaces around selected binary operators. For example:
+# 1 + 2 * 3 - 4 / 5
+# will be formatted as follows when configured with a value "*,/":
+# 1 + 2*3 - 4/5
+NO_SPACES_AROUND_SELECTED_BINARY_OPERATORS=False
+
+# Set to True to prefer spaces around the assignment operator for
+# default or keyword arguments.
+SPACES_AROUND_DEFAULT_OR_NAMED_ASSIGN=False
+
+# The number of spaces required before a trailing comment.
+SPACES_BEFORE_COMMENT=2
+
+# Insert a space between the ending comma and closing bracket of a list,
+# etc.
+SPACE_BETWEEN_ENDING_COMMA_AND_CLOSING_BRACKET=False
+
+# Split before arguments if the argument list is terminated by a
+# comma.
+SPLIT_ARGUMENTS_WHEN_COMMA_TERMINATED=True
+
+# Set to True to prefer splitting before '&', '|' or '^' rather than
+# after.
+SPLIT_BEFORE_BITWISE_OPERATOR=False
+
+# Split before a dictionary or set generator (comp_for). For example,
+# note the split before the for:
+#
+# foo = {
+#     variable: 'Hello world, have a nice day!'
+#     for variable in bar if variable != 42
+# }
+SPLIT_BEFORE_DICT_SET_GENERATOR=True
+
+# Split after the opening paren which surrounds an expression if it doesn't fit on a single line.
+SPLIT_BEFORE_EXPRESSION_AFTER_OPENING_PAREN=True
+
+# If an argument / parameter list is going to be split, then split
+# before the first argument.
+SPLIT_BEFORE_FIRST_ARGUMENT=False
+
+# Set to True to prefer splitting before 'and' or 'or' rather than
+# after.
+SPLIT_BEFORE_LOGICAL_OPERATOR=False
+
+# Split named assignments onto individual lines.
+SPLIT_BEFORE_NAMED_ASSIGNS=False
+
+# For list comprehensions and generator expressions with multiple clauses
+SPLIT_COMPLEX_COMPREHENSION=False
+
+# The penalty for splitting right after the opening bracket.
+SPLIT_PENALTY_AFTER_OPENING_BRACKET=2000
+
+# The penalty for splitting the line after a unary operator.
+SPLIT_PENALTY_AFTER_UNARY_OPERATOR=10000
+
+# The penalty for splitting right before an if expression.
+SPLIT_PENALTY_BEFORE_IF_EXPR=0
+
+# The penalty of splitting the line around the '&', '|', and '^'
+# operators.
+SPLIT_PENALTY_BITWISE_OPERATOR=300
+
+# The penalty for splitting a list comprehension or generator expression.
+SPLIT_PENALTY_COMPREHENSION=80
+
+# The penalty for characters over the column limit.
+SPLIT_PENALTY_EXCESS_CHARACTER=2600
+
+# The penalty incurred by adding a line split to the unwrapped
+# line. The more line splits added the higher the penalty.
+SPLIT_PENALTY_FOR_ADDED_LINE_SPLIT=30
+
+# The penalty of splitting a list of "import as" names. For example:
+#
+#   from a_very_long_or_indented_module_name_yada_yad import (long_argument_1,
+#                                                             long_argument_2,
+#                                                             long_argument_3)
+#
+# would reformat to something like:
+#
+#   from a_very_long_or_indented_module_name_yada_yad import (
+#       long_argument_1, long_argument_2, long_argument_3)
+SPLIT_PENALTY_IMPORT_NAMES=0
+
+# The penalty of splitting the line around the 'and' and 'or'
+# operators.
+SPLIT_PENALTY_LOGICAL_OPERATOR=300
+
+# Use the Tab character for indentation.
+USE_TABS=False
+
+# Allow splits before the dictionary value.
+ALLOW_SPLIT_BEFORE_DICT_VALUE=False

bower.json

@@ -17,7 +17,7 @@
     "jquery": "2.0.3",
     "underscore": "~1.7.0",
     "readthedocs-client": "https://github.com/agjohnson/readthedocs-client-js.git",
-    "sphinx-rtd-theme": "https://github.com/snide/sphinx-rtd-theme.git#0.2.4",
+    "sphinx-rtd-theme": "https://github.com/snide/sphinx-rtd-theme.git#0.2.5b1",
     "knockout": "~3.3.0",
     "jquery.payment": "~1.3.0",
     "jquery-migrate": "~1.2.1",

contrib/readme.rst

@@ -0,0 +1,28 @@
+Running Read the Docs via Supervisord
+=====================================
+
+This is the easiest way to start all of the commands you'll need for development
+in an environment relatively close to the production evironment. All you need is
+``supervisord`` and ``redis-server``. Installation of ``redis-server`` is
+outside the scope of this documentation, but once installed, all you need to run
+from ``supervisord`` is::
+
+    pip install supervisor
+    cd contrib/
+    supervisord
+
+This will bring up a web instance for the dashboard, a web instance for
+documentation serving, two celery instances, and redis-server. 
+
+If you already are running redis-server, this will complain about the port
+already being in use, but will still load.
+
+Debugging
+---------
+
+To debug, set trace points like normal, with ``pdb``/``ipdb``. Then you can
+connect to the process by bringing it to the foreground::
+
+    supervisorctl fg main
+
+You'll still see logging to STDERR on the main supervisord process page.

contrib/supervisord.conf

@@ -0,0 +1,42 @@
+[supervisord]
+nodaemon = True
+directory = ../
+loglevel = error
+strip_ansi = False
+environment = PYTHONUNBUFFERED=1,READTHEDOCS_INSTANCE=readthedocs.org
+
+[inet_http_server]
+port = 127.0.0.1:9001
+username = 🍔
+password = 🍟
+
+[supervisorctl]
+username = 🍔
+password = 🍟
+
+[rpcinterface:supervisor]
+supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
+
+[program:redis]
+command = redis-server
+directory = ../
+priority = 0
+startretries = 0
+stderr_logfile = /dev/stderr
+stderr_logfile_maxbytes = 0
+
+[program:main]
+command = python manage.py runserver 8000
+directory = ../
+priority = 100
+stopasgroup = True
+stderr_logfile = /dev/stderr
+stderr_logfile_maxbytes = 0
+
+[program:celery]
+command = celery worker -A readthedocs -Q default,celery,web,builder -l DEBUG -c 2
+directory = ../
+priority = 100
+stopasgroup = True
+stderr_logfile = /dev/stderr
+stderr_logfile_maxbytes = 0