Skip to content

Commit

Permalink
Start quick start guide
Browse files Browse the repository at this point in the history
  • Loading branch information
timothycrosley committed Jul 1, 2020
1 parent aff8ff4 commit 664aca3
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ editors](https://github.com/timothycrosley/isort/wiki/isort-Plugins) to
quickly sort all your imports. It requires Python 3.6+ to run but
supports formatting Python 2 code too.

[Try isort now from your browser!](https://timothycrosley.github.io/isort/docs/interactive/try/)
[Try isort now from your browser!](https://timothycrosley.github.io/isort/docs/quick_start/0.-try/)

![Example Usage](https://raw.github.com/timothycrosley/isort/develop/example.gif)

Expand Down
10 changes: 6 additions & 4 deletions docs/major_releases/introducing_isort_5.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,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/)
[Try isort 5 right now from your browser!](https://timothycrosley.github.io/isort/docs/quick_start/0.-try/)

So why the massive change?

Expand Down Expand Up @@ -129,8 +129,10 @@ It went from fully dynamic to fully static typing using mypy. Finally, it utiliz

# Give 5.0.0 a try!

[Try isort 5 right now from your browser!](https://timothycrosley.github.io/isort/docs/interactive/try/)
[Try isort 5 right now from your browser!](https://timothycrosley.github.io/isort/docs/quick_start/0.-try/)

or
OR

Install isort locally using `pip3 install isort`
Install isort locally using `pip3 install isort`.

[Click here for full installation instructions.](https://timothycrosley.github.io/isort/docs/quick_start/1.-install/)
6 changes: 4 additions & 2 deletions docs/interactive/try.md → docs/quick_start/0.-try.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/interactive/interactive.css">
<link rel="stylesheet" type="text/css" href="https://timothycrosley.github.io/isort/docs/quick_start/interactive.css">
</head>


Expand Down Expand Up @@ -43,6 +43,8 @@ import b, a
</div>
</div>

<script src="https://timothycrosley.github.io/isort/docs/interactive/interactive.js"></script>
<script src="https://timothycrosley.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/)
22 changes: 22 additions & 0 deletions docs/quick_start/1.-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Install `isort` using your preferred Python package manager:

`pip3 install isort`

OR

`poetry add isort`

OR

`pipenv install isort`

OR

For a fully isolated user installation you can use [pipx](https://github.com/pipxproject/pipx)

`pipx install isort`

<script id="asciicast-tCfIczk0HS4N8iM7g1TwEUB7y" src="https://asciinema.org/a/tCfIczk0HS4N8iM7g1TwEUB7y.js" async></script>

!!!tip
If you want isort to act as a linter for projects, it probably makes since to add isort as an explicit development dependency for each project that uses it. If, on the other hand, you are an individual developer simply using isort as a personal tool to clean up your own commits, a global or user level installation makes sense. Both are seamlessly supported on a single machine.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,5 @@ def use_isort(*args):
document.sort_code = sort_code
document.updateOutput()
micropip.install('https://timothycrosley.github.io/isort/docs/interactive/isort-5.0.0-py3-none-any.whl').then(use_isort)`);
micropip.install('https://timothycrosley.github.io/isort/docs/quick_start/isort-5.0.0-py3-none-any.whl').then(use_isort)`);
});

0 comments on commit 664aca3

Please sign in to comment.