:ref:`the-style-file` for your project should be configured in the [tool.nitpick]
section of the configuration file.
Possible configuration files (in order of precedence):
.nitpick.toml
pyproject.toml
The first file found will be used; the other files will be ignored.
Run the nipick init
CLI command to create a config file (:ref:`cli_cmd_init`).
To configure your own style:
[tool.nitpick]
style = "/path/to/your-style-file.toml"
You can set style
with any local file or URL.
Use the URL of the remote file. If it's hosted on GitHub, use the raw GitHub URL:
[tool.nitpick]
style = "https://raw.githubusercontent.com/andreoliwa/nitpick/v0.26.0/nitpick-style.toml"
You can also use the raw URL of a GitHub Gist:
[tool.nitpick]
style = "https://gist.githubusercontent.com/andreoliwa/f4fccf4e3e83a3228e8422c01a48be61/raw/ff3447bddfc5a8665538ddf9c250734e7a38eabb/remote-style.toml"
Remote styles can be cached to avoid unnecessary HTTP requests.
The cache can be configured with the cache
key; see the examples below.
By default, remote styles will be cached for one hour.
This default will also be used if the cache
key has an invalid value.
The cache can be set to expire after a defined time unit.
Use the format cache = "<integer> <time unit>"
.
Time unit can be one of these (plural or singular, it doesn't matter):
minutes
/minute
hours
/hour
days
/day
weeks
/week
To cache for 15 minutes:
[tool.nitpick]
style = "https://example.com/remote-style.toml"
cache = "15 minutes"
To cache for 1 day:
[tool.nitpick]
style = "https://example.com/remote-style.toml"
cache = "1 day"
With this option, once the style(s) are cached, they never expire.
[tool.nitpick]
style = "https://example.com/remote-style.toml"
cache = "forever"
With this option, the cache is never used. The remote style file(s) are always looked-up and a HTTP request is always executed.
[tool.nitpick]
style = "https://example.com/remote-style.toml"
cache = "never"
The cache files live in a subdirectory of your project: /path/to/your/project/.cache/nitpick/
.
To clear the cache, simply remove this directory.
Using a file in your home directory:
[tool.nitpick]
style = "~/some/path/to/another-style.toml"
Using a relative path from another project in your hard drive:
[tool.nitpick]
style = "../another-project/another-style.toml"
You can also use multiple styles and mix local files and URLs:
[tool.nitpick]
style = [
"/path/to/first.toml",
"/another/path/to/second.toml",
"https://example.com/on/the/web/third.toml"
]
Note
The order is important: each style will override any keys that might be set by the previous .toml
file.
If a key is defined in more than one file, the value from the last file will prevail.
You can use a remote style as a starting point, and override settings on your local style file.
Use ./
to indicate the local style:
[tool.nitpick]
style = [
"https://example.com/on/the/web/remote-style.toml",
"./my-local-style.toml",
]