diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/options.md | 2 | ||||
| -rw-r--r-- | docs/contributing/1.-contributing-guide.md | 6 | ||||
| -rw-r--r-- | docs/major_releases/introducing_isort_5.md | 18 | ||||
| -rw-r--r-- | docs/quick_start/0.-try.md | 8 | ||||
| -rw-r--r-- | docs/quick_start/2.-cli.md | 2 | ||||
| -rw-r--r-- | docs/quick_start/3.-api.md | 2 | ||||
| -rw-r--r-- | docs/upgrade_guides/5.0.0.md | 14 | ||||
| -rw-r--r-- | docs/warning_and_error_codes/W0500.md | 2 |
8 files changed, 27 insertions, 27 deletions
diff --git a/docs/configuration/options.md b/docs/configuration/options.md index 307169d5..712b14ae 100644 --- a/docs/configuration/options.md +++ b/docs/configuration/options.md @@ -4,7 +4,7 @@ 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/). +Too busy to build your perfect isort configuration? For curated common configurations, see isort's [built-in profiles](https://pycqa.github.io/isort/docs/configuration/profiles/). ## Python Version diff --git a/docs/contributing/1.-contributing-guide.md b/docs/contributing/1.-contributing-guide.md index 04b3bb9b..e51e852d 100644 --- a/docs/contributing/1.-contributing-guide.md +++ b/docs/contributing/1.-contributing-guide.md @@ -21,7 +21,7 @@ Base System Requirements: Once you have verified that your system matches the base requirements you can start to get the project working by following these steps: -1. [Fork the project on GitHub](https://github.com/timothycrosley/isort/fork). +1. [Fork the project on GitHub](https://github.com/pycqa/isort/fork). 2. Clone your fork to your local file system: `git clone https://github.com/$GITHUB_ACCOUNT/isort.git` 3. `cd isort` @@ -57,10 +57,10 @@ A local test cycle might look like the following: ## Making a contribution Congrats! You're now ready to make a contribution! Use the following as a guide to help you reach a successful pull-request: -1. Check the [issues page](https://github.com/timothycrosley/isort/issues) on GitHub to see if the task you want to complete is listed there. +1. Check the [issues page](https://github.com/pycqa/isort/issues) on GitHub to see if the task you want to complete is listed there. - If it's listed there, write a comment letting others know you are working on it. - If it's not listed in GitHub issues, go ahead and log a new issue. Then add a comment letting everyone know you have it under control. - - If you're not sure if it's something that is good for the main isort project and want immediate feedback, you can discuss it [here](https://gitter.im/timothycrosley/isort). + - If you're not sure if it's something that is good for the main isort project and want immediate feedback, you can discuss it [here](https://gitter.im/pycqa/isort). 2. Create an issue branch for your local work `git checkout -b issue/$ISSUE-NUMBER`. 3. Do your magic here. 4. Ensure your code matches the [HOPE-8 Coding Standard](https://github.com/hugapi/HOPE/blob/master/all/HOPE-8--Style-Guide-for-Hug-Code.md#hope-8----style-guide-for-hug-code) used by the project. diff --git a/docs/major_releases/introducing_isort_5.md b/docs/major_releases/introducing_isort_5.md index bc8c96e5..a5cbdda9 100644 --- a/docs/major_releases/introducing_isort_5.md +++ b/docs/major_releases/introducing_isort_5.md @@ -1,16 +1,16 @@ # Introducing isort 5 -[](https://timothycrosley.github.io/isort/) +[](https://pycqa.github.io/isort/) 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. -[Click here for an attempt at full changelog with a list of breaking changes.](https://timothycrosley.github.io/isort/CHANGELOG/) +[Click here for an attempt at full changelog with a list of breaking changes.](https://pycqa.github.io/isort/CHANGELOG/) -[Using isort 4.x.x? Click here for the isort 5.0.0 upgrade guide.](https://timothycrosley.github.io/isort/docs/upgrade_guides/5.0.0/) +[Using isort 4.x.x? Click here for the isort 5.0.0 upgrade guide.](https://pycqa.github.io/isort/docs/upgrade_guides/5.0.0/) -[Try isort 5 right now from your browser!](https://timothycrosley.github.io/isort/docs/quick_start/0.-try/) +[Try isort 5 right now from your browser!](https://pycqa.github.io/isort/docs/quick_start/0.-try/) So why the massive change? @@ -105,7 +105,7 @@ import c import d ``` -isort 5 adds support for [Action Comments](https://timothycrosley.github.io/isort/docs/configuration/action_comments/) which provide a quick and convient way to control the flow of parsing within single source files. +isort 5 adds support for [Action Comments](https://pycqa.github.io/isort/docs/configuration/action_comments/) which provide a quick and convient way to control the flow of parsing within single source files. # First class Python API @@ -122,21 +122,21 @@ import b """ ``` -isort now exposes its programmatic API as a first-class citizen. This API makes it easy to extend or use isort in your own Python project. You can see the full documentation for this new API [here](https://timothycrosley.github.io/isort/reference/isort/api/). +isort now exposes its programmatic API as a first-class citizen. This API makes it easy to extend or use isort in your own Python project. You can see the full documentation for this new API [here](https://pycqa.github.io/isort/reference/isort/api/). # Solid base for the future A major focus for the release was to give isort a solid foundation for the next 5-10 years of the project's life. isort has been refactored into functional components that are easily testable. The project now has 100% code coverage. It utilizes tools like [Hypothesis](https://hypothesis.readthedocs.io/en/latest/) to reduce the number of unexpected errors. -It went from fully dynamic to fully static typing using mypy. Finally, it utilizes the latest linters both on (like [DeepSource](https://deepsource.io/gh/timothycrosley/isort/)) and offline (like [Flake8](https://flake8.pycqa.org/en/latest/)) to help ensure a higher bar for all code contributions into the future. +It went from fully dynamic to fully static typing using mypy. Finally, it utilizes the latest linters both on (like [DeepSource](https://deepsource.io/gh/pycqa/isort/)) and offline (like [Flake8](https://flake8.pycqa.org/en/latest/)) to help ensure a higher bar for all code contributions into the future. # Give 5.0.0 a try! -[Try isort 5 right now from your browser!](https://timothycrosley.github.io/isort/docs/quick_start/0.-try/) +[Try isort 5 right now from your browser!](https://pycqa.github.io/isort/docs/quick_start/0.-try/) OR Install isort locally using `pip3 install isort`. -[Click here for full installation instructions.](https://timothycrosley.github.io/isort/docs/quick_start/1.-install/) +[Click here for full installation instructions.](https://pycqa.github.io/isort/docs/quick_start/1.-install/) diff --git a/docs/quick_start/0.-try.md b/docs/quick_start/0.-try.md index d2c32f6f..61fae153 100644 --- a/docs/quick_start/0.-try.md +++ b/docs/quick_start/0.-try.md @@ -13,7 +13,7 @@ Use our live isort editor to see how isort can help improve the formatting of yo </script> <script src="https://pyodide-cdn2.iodide.io/v0.15.0/full/pyodide.js"></script> <script src="https://pagecdn.io/lib/ace/1.4.5/ace.js" integrity="sha256-5Xkhn3k/1rbXB+Q/DX/2RuAtaB4dRRyQvMs83prFjpM=" crossorigin="anonymous"></script> -<link rel="stylesheet" type="text/css" href="https://timothycrosley.github.io/isort/docs/quick_start/interactive.css"> +<link rel="stylesheet" type="text/css" href="https://pycqa.github.io/isort/docs/quick_start/interactive.css"> </head> @@ -32,7 +32,7 @@ import b, a <div id="outputEditor" class="editor">Loading...</div> <div> - Configuration (Note: the below must follow JSON format). Full configuration guide is <a href="https://timothycrosley.github.io/isort/docs/configuration/options/">here</a>: + Configuration (Note: the below must follow JSON format). Full configuration guide is <a href="https://pycqa.github.io/isort/docs/configuration/options/">here</a>: <div id="configEditor" class="configurator">{"line_length": 80, "profile": "black", @@ -43,8 +43,8 @@ import b, a </div> </div> -<script src="https://timothycrosley.github.io/isort/docs/quick_start/interactive.js"></script> +<script src="https://pycqa.github.io/isort/docs/quick_start/interactive.js"></script> <div style="clear:both;"></div> Like what you saw? Installing isort to use locally is as simple as `pip3 install isort`. -[Click here for full installation instructions.](https://timothycrosley.github.io/isort/docs/quick_start/1.-install/) +[Click here for full installation instructions.](https://pycqa.github.io/isort/docs/quick_start/1.-install/) diff --git a/docs/quick_start/2.-cli.md b/docs/quick_start/2.-cli.md index 844533f6..f7b31346 100644 --- a/docs/quick_start/2.-cli.md +++ b/docs/quick_start/2.-cli.md @@ -3,7 +3,7 @@ Once installed, `isort` exposes a command line utility for sorting, organizing, and formatting imports within Python and Cython source files. To verify the tool is installed correctly, run `isort` from the command line and you should be given the available commands and the version of isort installed. -For a list of all CLI options type `isort --help` or view [the online configuration reference](https://timothycrosley.github.io/isort/docs/configuration/options/): +For a list of all CLI options type `isort --help` or view [the online configuration reference](https://pycqa.github.io/isort/docs/configuration/options/): <script id="asciicast-346599" src="https://asciinema.org/a/346599.js" async></script> diff --git a/docs/quick_start/3.-api.md b/docs/quick_start/3.-api.md index 9e6d2e96..1583357f 100644 --- a/docs/quick_start/3.-api.md +++ b/docs/quick_start/3.-api.md @@ -19,4 +19,4 @@ Highlights include: - `isort.place_module` - Takes the name of a module as a string and returns the categorization determined for it. - `isort.place_module_with_reason` - Takes the name of a module as a string and returns the categorization determined for it and why that categorization was given. -For a full definition of the API see the [API reference documentation](https://timothycrosley.github.io/isort/reference/isort/api/) or try `help(isort)` from an interactive interpreter. +For a full definition of the API see the [API reference documentation](https://pycqa.github.io/isort/reference/isort/api/) or try `help(isort)` from an interactive interpreter. diff --git a/docs/upgrade_guides/5.0.0.md b/docs/upgrade_guides/5.0.0.md index 0b17595d..6a68acec 100644 --- a/docs/upgrade_guides/5.0.0.md +++ b/docs/upgrade_guides/5.0.0.md @@ -5,8 +5,8 @@ This guide is meant to help migrate projects from using isort 4.x.x unto the 5.0 Related documentation: -* [isort 5.0.0 changelog](https://timothycrosley.github.io/isort/CHANGELOG/#500-penny-july-4-2020) -* [isort 5 release document](https://timothycrosley.github.io/isort/docs/major_releases/introducing_isort_5/) +* [isort 5.0.0 changelog](https://pycqa.github.io/isort/CHANGELOG/#500-penny-july-4-2020) +* [isort 5 release document](https://pycqa.github.io/isort/docs/major_releases/introducing_isort_5/) !!! important - "If you use pre-commit remove seed-isort-config." If you currently use pre-commit, make sure to see the pre-commit section of this document. In particular, make sure to remove any `seed-isort-config` pre-step. @@ -19,7 +19,7 @@ for those of us who have gotten used to placing imports right above their usage If you want to move all imports to the top, you can use the new`--float-to-top` flag in the CLI or `float_to_top=true` option in your config file. -See: [https://timothycrosley.github.io/isort/docs/configuration/options/#float-to-top](https://timothycrosley.github.io/isort/docs/configuration/options/#float-to-top) +See: [https://pycqa.github.io/isort/docs/configuration/options/#float-to-top](https://pycqa.github.io/isort/docs/configuration/options/#float-to-top) ## Migrating CLI options @@ -46,7 +46,7 @@ The `-v` (previously for version now for verbose) and `-V` (previously for verbo The first thing to keep in mind is how isort loads config options has changed in isort 5. It will no longer merge multiple config files, instead you must have 1 isort config per a project. If you have multiple configs, they will need to be merged into 1 single one. You can see the priority order of configuration files and the manor in which they are loaded on the -[config files documentation page](https://timothycrosley.github.io/isort/docs/configuration/config_files/). +[config files documentation page](https://pycqa.github.io/isort/docs/configuration/config_files/). ### `not_skip` This is the same as the `--dont-skip` CLI option above. In an earlier version isort had a default skip of `__init__.py`. To get around that many projects wanted a way to not skip `__init__.py` or any other files that were automatically skipped in the future by isort. isort no longer has any default skips, so if the value here is `__init__.py` you can simply remove the setting. If it is something else, just make sure you aren't specifying to skip that file somewhere else in your config. @@ -58,10 +58,10 @@ The option was originally added to allow working around this, and was then turne ### `known_standard_library` isort settings no longer merge together, instead they override. The old behavior of merging together caused many hard to track down errors, but the one place it was very convenient was for adding a few additional standard library modules. -In isort 5, you can still get this behavior by moving your extra modules from the `known_standard_library` setting to [`extra_standard_library`](https://timothycrosley.github.io/isort/docs/configuration/options/#extra-standard-library). +In isort 5, you can still get this behavior by moving your extra modules from the `known_standard_library` setting to [`extra_standard_library`](https://pycqa.github.io/isort/docs/configuration/options/#extra-standard-library). ### module placement changes: `known_third_party`, `known_first_party`, `default_section`, etc... -isort has completely rewritten its logic for placing modules in 5.0.0 to ensure the same behavior across environments. You can see the details of this change [here](https://github.com/timothycrosley/isort/issues/1147). +isort has completely rewritten its logic for placing modules in 5.0.0 to ensure the same behavior across environments. You can see the details of this change [here](https://github.com/pycqa/isort/issues/1147). The TL;DR of which is that isort has now changed from `default_section=FIRSTPARTY` to `default_section=THIRDPARTY`. If you all already setting the default section to third party, your config is probably in good shape. If not, you can either use the old finding approach with `--magic-placement` in the CLI or `old_finders=True` in your config, or preferably, you are able to remove all placement options and isort will determine it correctly. If it doesn't, you should be able to just specify your projects modules with `known_first_party` and be done with it. @@ -77,7 +77,7 @@ If you have a step in your precommit called `seed-isort-config` or similar, it i isort now includes an optimized precommit configuration in the repo itself. To use it you can replace any existing isort precommit step with: ``` - - repo: https://github.com/timothycrosley/isort + - repo: https://github.com/pycqa/isort rev: 5.3.2 hooks: - id: isort diff --git a/docs/warning_and_error_codes/W0500.md b/docs/warning_and_error_codes/W0500.md index 2a214808..a924ffc9 100644 --- a/docs/warning_and_error_codes/W0500.md +++ b/docs/warning_and_error_codes/W0500.md @@ -3,7 +3,7 @@ The W0500 error codes are reserved for warnings related to a major release of the isort project. Generally, the existence of any of these will trigger one additional warning listing the upgrade guide. -For the most recent upgrade guide, see: [The 5.0.0 Upgrade Guide.](https://timothycrosley.github.io/isort/docs/upgrade_guides/5.0.0/). +For the most recent upgrade guide, see: [The 5.0.0 Upgrade Guide.](https://pycqa.github.io/isort/docs/upgrade_guides/5.0.0/). ## W0501: Deprecated CLI flags were included that will be ignored. |