b1d0601016
To summarise, based on what was discussed in that issue: due to not being able to parse automagics (e.g. pip install black) without a running IPython kernel, cells with syntax which is parseable by neither ast.parse nor IPython will be skipped cells with multiline magics will be skipped trailing semicolons will be preserved, as they are often put there intentionally in Jupyter Notebooks to suppress unnecessary output Commit history before merge (excluding merge commits): * wip * fixup tests * skip tests if no IPython * install test requirements in ipynb tests * if --ipynb format all as ipynb * wip * add some whole-notebook tests * docstrings * skip multiline magics * add test for nested cell magic * remove ipynb_test.yml, put ipynb tests in tox.ini * add changelog entry * typo * make token same length as magic it replaces * only include .ipynb by default if jupyter dependencies are found * remove logic from const * fixup * fixup * re.compile * noop * clear up * new_src -> dst * early exit for non-python notebooks * add non-python test notebook * add repo with many notebooks to black-primer * install extra dependencies for black-primer * fix planetary computer examples url * dont run on ipynb files by default * add scikit-lego (Expected to change) to black-primer * add ipynb-specific diff * fixup * run on all (including ipynb) by default * remove --include .ipynb from scikit-lego black-primer * use tokenize so as to mirror the exact logic in IPython.core.displayhooks quiet * fixup * 🎨 * clarify docstring * add test for when comment is after trailing semicolon * enumerate(reversed) instead of [::-1] * clarify docstrings * wip * use jupyter and no_jupyter marks * use THIS_DIR * windows fixup * perform safe check cell-by-cell for ipynb * only perform safe check in ipynb if not fast * remove redundant Optional * 🎨 * use typeguard * dont process cell containing transformed magic * require typing extensions before 3.10 so as to have TypeGuard * use dataclasses * mention black[jupyter] in docs as well as in README * add faq * add message to assertion error * add test for indented quieted cell * use tokenize_rt else we cant roundtrip * fmake fronzet set for tokens to ignore when looking for trailing semicolon * remove planetary code examples as recent commits result in changes * use dataclasses which inherit from ast.NodeVisitor * bump typing-extensions so that TypeGuard is available * bump typing-extensions in Pipfile * add test with notebook with empty metadata * pipenv lock * deprivative validate_cell * Update README.md * Update docs/getting_started.md * dont cache notebooks if jupyter dependencies arent found * dont write to cache if jupyter deps are not installed * add notebook which cant be parsed * use clirunner * remove other subprocess calls * add docstring * make verbose and quiet keyword only * 🎨 * run second many test on directory, not on file * test for warning message when running on directory * early return from non-python cell magics * move NothingChanged to report to avoid circular import * remove circular import * reinstate --ipynb flag Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
# Getting Started
|
|
|
|
New to _Black_? Don't worry, you've found the perfect place to get started!
|
|
|
|
## Do you like the _Black_ code style?
|
|
|
|
Before using _Black_ on some of your code, it might be a good idea to first understand
|
|
how _Black_ will format your code. _Black_ isn't for everyone and you may find something
|
|
that is a dealbreaker for you personally, which is okay! The current _Black_ code style
|
|
[is described here](./the_black_code_style/current_style.md).
|
|
|
|
## Try it out online
|
|
|
|
Also, you can try out _Black_ online for minimal fuss on the
|
|
[Black Playground](https://black.vercel.app) generously created by José Padilla.
|
|
|
|
## Installation
|
|
|
|
_Black_ can be installed by running `pip install black`. It requires Python 3.6.2+ to
|
|
run, but can format Python 2 code too. Python 2 support needs the `typed_ast`
|
|
dependency, which be installed with `pip install black[python2]`. If you want to format
|
|
Jupyter Notebooks, install with `pip install black[jupyter]`.
|
|
|
|
If you can't wait for the latest _hotness_ and want to install from GitHub, use:
|
|
|
|
`pip install git+git://github.com/psf/black`
|
|
|
|
## Basic usage
|
|
|
|
To get started right away with sensible defaults:
|
|
|
|
```sh
|
|
black {source_file_or_directory}...
|
|
```
|
|
|
|
You can run _Black_ as a package if running it as a script doesn't work:
|
|
|
|
```sh
|
|
python -m black {source_file_or_directory}...
|
|
```
|
|
|
|
## Next steps
|
|
|
|
Took a look at [the _Black_ code style](./the_black_code_style/current_style.md) and
|
|
tried out _Black_? Fantastic, you're ready for more. Why not explore some more on using
|
|
_Black_ by reading
|
|
[Usage and Configuration: The basics](./usage_and_configuration/the_basics.md).
|
|
Alternatively, you can check out the
|
|
[Introducing _Black_ to your project](./guides/introducing_black_to_your_project.md)
|
|
guide.
|