diff options
| author | Timothy Crosley <timothy.crosley@gmail.com> | 2020-06-30 23:59:14 -0700 |
|---|---|---|
| committer | Timothy Crosley <timothy.crosley@gmail.com> | 2020-06-30 23:59:14 -0700 |
| commit | 937e7b2e4f661cd9eb922f1f5036b09eb5b01c8f (patch) | |
| tree | baad9fe494126e54f355c76f9da520b3473d7bf2 /docs | |
| parent | d358eb26b1e4289871509608452b2df80bcde4a5 (diff) | |
| download | isort-937e7b2e4f661cd9eb922f1f5036b09eb5b01c8f.tar.gz | |
Add introduction header
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/options.md | 6 | ||||
| -rw-r--r-- | docs/major_releases/introducing_isort_5.md | 6 |
2 files changed, 8 insertions, 4 deletions
diff --git a/docs/configuration/options.md b/docs/configuration/options.md index 82fff98f..6ffcaafd 100644 --- a/docs/configuration/options.md +++ b/docs/configuration/options.md @@ -5,6 +5,8 @@ As a code formatter isort has opinions. However, it also allows you to have your isort will disagree but commit to your way of formatting. To enable this, isort exposes a plethora of options to specify how you want your imports sorted, organized, and formatted. +Too busy to build your perfect isort configuration? For curated common configurations, see isort's [built-in profiles](https://timothycrosley.github.io/isort/docs/configuration/profiles/). + ## Python Version Tells isort to set the known standard library based on the the specified Python version. Default is to assume any Python 3 version could be the target, and use a union off all stdlib modules across versions. If auto is specified, the version of the interpreter used to run isort (currently: 38) will be used. @@ -32,7 +34,7 @@ Force specific imports to the top of their appropriate section. Files that sort imports should skip over. If you want to skip multiple files you should specify twice: --skip file1 --skip file2. **Type:** Frozenset -**Default:** `frozenset({'venv', '.nox', 'node_modules', 'buck-out', '.mypy_cache', '.tox', '.pants.d', '.venv', 'build', '.git', '.eggs', '_build', 'dist', '.hg'})` +**Default:** `frozenset({'node_modules', '.hg', '_build', 'dist', 'build', '.eggs', '.tox', '.nox', 'buck-out', '.mypy_cache', '.pants.d', '.venv', 'venv', '.git'})` **Python & Config File Name:** skip **CLI Flags:** @@ -144,7 +146,7 @@ Force isort to recognize a module as being part of the current python project. Force isort to recognize a module as part of Python's standard library. **Type:** Frozenset -**Default:** `frozenset({'_thread', 'asyncio', 'cgitb', 'hmac', 'ctypes', 'multiprocessing', 'stat', 'functools', 'posixpath', 'atexit', 'configparser', 'tarfile', 'numbers', 'errno', 'gzip', 'cgi', 'concurrent', 'pwd', 'heapq', 'sqlite3', 'select', 'spwd', 'csv', 'distutils', 'syslog', 'time', 'quopri', 'shlex', 'audioop', 'fileinput', 'doctest', 'queue', 'email', 'pdb', 'fpectl', 'winsound', 'fcntl', 'glob', 'operator', 'colorsys', 'locale', 'contextlib', 'urllib', 'uu', 'venv', 'imaplib', 'pstats', 'dis', 'plistlib', 'sysconfig', 'lzma', 'weakref', 'unittest', 'signal', 'compileall', 'html', 'secrets', 'tracemalloc', 'aifc', 'profile', 'termios', 'test', 'turtledemo', 'tty', 'mailbox', 'ftplib', 'webbrowser', 'zipfile', 'asyncore', 're', 'unicodedata', 'linecache', 'json', 'types', 'shelve', 'pty', 'os', 'threading', 'bz2', 'encodings', 'grp', 'math', 'cProfile', 'builtins', 'inspect', 'collections', 'nis', 'chunk', 'turtle', 'uuid', 'getopt', 'symtable', 'token', 'dataclasses', 'array', 'codecs', 'pipes', 'itertools', 'netrc', 'binascii', 'telnetlib', 'filecmp', 'winreg', 'zipimport', 'symbol', 'decimal', 'difflib', 'traceback', 'mmap', 'smtplib', 'argparse', 'string', 'poplib', 'rlcompleter', 'wave', 'site', 'macpath', 'zlib', 'bdb', 'socketserver', 'cmath', 'modulefinder', 'bisect', 'mimetypes', 'statistics', 'trace', 'binhex', 'fnmatch', 'pkgutil', 'pyclbr', 'xml', 'readline', 'xmlrpc', 'tokenize', 'resource', 'keyword', 'copyreg', 'getpass', 'ast', 'abc', 'ipaddress', 'sched', 'runpy', 'crypt', 'textwrap', 'contextvars', 'random', 'marshal', 'ssl', 'selectors', 'timeit', 'ntpath', 'ensurepip', 'parser', 'msvcrt', 'sndhdr', 'typing', 'formatter', 'pathlib', 'platform', 'lib2to3', 'base64', 'ossaudiodev', 'nntplib', 'dbm', 'asynchat', 'mailcap', 'copy', 'reprlib', 'tempfile', 'enum', 'posix', 'dummy_threading', 'faulthandler', 'py_compile', 'gc', 'hashlib', 'fractions', 'smtpd', 'pprint', 'zipapp', 'tabnanny', 'sre_constants', 'logging', 'sunau', 'pickletools', 'importlib', 'stringprep', 'struct', 'subprocess', 'optparse', 'tkinter', 'http', '_dummy_thread', 'curses', 'socket', 'shutil', 'wsgiref', 'gettext', 'pydoc', 'sys', 'pickle', 'io', 'imghdr', 'xdrlib', 'msilib', 'cmd', 'datetime', 'imp', 'codeop', 'calendar', 'code', 'warnings'})` +**Default:** `frozenset({'distutils', 'webbrowser', 'codeop', 'binhex', 'tempfile', 'platform', 'struct', 'base64', 'calendar', 'ast', 'abc', 'pwd', 'spwd', 'plistlib', 'numbers', 'secrets', 'signal', 'grp', 'unittest', 'statistics', 'typing', 'imaplib', 'multiprocessing', 'uuid', 'wsgiref', 'email', 'tokenize', 'getpass', 'asynchat', 'imp', 'mmap', 'sys', 'colorsys', 'cmath', 'tabnanny', 'rlcompleter', 'json', 'sqlite3', 'pprint', 'copyreg', 'zipapp', 'contextvars', 'tarfile', 'telnetlib', 'fileinput', 'modulefinder', 'curses', 'syslog', 'imghdr', 'copy', 'msvcrt', 'cgi', 'weakref', 'datetime', 'dataclasses', 'optparse', 'locale', 'ossaudiodev', '_thread', 'fcntl', 'sched', 'zipfile', 'subprocess', 'formatter', 'operator', 'xml', 'faulthandler', 'dummy_threading', 'shlex', 'argparse', 'trace', 'ntpath', 'unicodedata', 'uu', 'symbol', 'atexit', 'ipaddress', 'runpy', 'binascii', 'doctest', 'termios', 'lzma', 'pdb', 'shutil', 'readline', 'zlib', 're', 'zipimport', 'audioop', 'quopri', 'sndhdr', 'venv', 'msilib', 'array', 'symtable', 'encodings', 'timeit', 'nis', 'http', 'fnmatch', 'codecs', 'stat', 'csv', 'site', 'mimetypes', 'inspect', 'poplib', 'getopt', 'pipes', 'select', 'configparser', 'dbm', 'time', 'html', 'os', 'logging', 'types', 'chunk', 'winreg', 'nntplib', 'compileall', 'pydoc', 'bisect', 'warnings', 'py_compile', 'random', 'importlib', 'cProfile', 'tty', 'linecache', 'shelve', 'parser', 'gc', 'mailbox', 'reprlib', 'token', 'turtledemo', 'pty', 'contextlib', 'hmac', 'socket', 'asyncore', 'keyword', 'pkgutil', 'aifc', 'bdb', 'queue', 'xdrlib', 'ctypes', 'dis', 'ftplib', 'gzip', 'smtplib', 'code', 'pickle', 'socketserver', 'fpectl', 'resource', 'sunau', 'io', 'bz2', 'decimal', 'traceback', 'hashlib', 'smtpd', 'itertools', 'concurrent', 'textwrap', 'pstats', 'tracemalloc', 'sysconfig', 'errno', 'mailcap', 'pickletools', 'test', 'pathlib', 'functools', 'tkinter', 'xmlrpc', 'ensurepip', 'string', 'enum', '_dummy_thread', 'profile', 'glob', 'math', 'posixpath', 'builtins', 'fractions', 'crypt', 'urllib', 'gettext', 'ssl', 'sre_constants', 'collections', 'asyncio', 'netrc', 'filecmp', 'turtle', 'stringprep', 'selectors', 'heapq', 'macpath', 'winsound', 'marshal', 'posix', 'pyclbr', 'cgitb', 'difflib', 'threading', 'wave', 'cmd', 'lib2to3'})` **Python & Config File Name:** known_standard_library **CLI Flags:** diff --git a/docs/major_releases/introducing_isort_5.md b/docs/major_releases/introducing_isort_5.md index 8e0be01e..fe9198a8 100644 --- a/docs/major_releases/introducing_isort_5.md +++ b/docs/major_releases/introducing_isort_5.md @@ -1,3 +1,5 @@ +# Introducing isort 5 + isort 5.0.0 is the first major release of isort in over five years and the first significant refactoring of isort since it was conceived more than ten years ago. It's also the first version to require Python 3 (Python 3.6+ at that!) to run - though it can still be run on source files from any version of Python. This does mean that there may be some pain with the upgrade process, but we believe the improvements will be well worth it. @@ -5,7 +7,7 @@ This does mean that there may be some pain with the upgrade process, but we beli [Click here for an attempt at full changelog with a list of breaking changes.](https://timothycrosley.github.io/isort/CHANGELOG/) [Try isort 5 right now from your browser!](https://timothycrosley.github.io/isort/docs/interactive/try/) -So why the massive change? +So why the massive change? # Profile support ``` @@ -108,6 +110,6 @@ It went from fully dynamic to fully static typing using mypy. Finally, it utiliz [Try isort 5 right now from your browser!](https://timothycrosley.github.io/isort/docs/interactive/try/) -or +or Install isort locally using `pip3 install isort` |
