nixpkgs/pkgs/tools/misc/nbqa/default.nix
2024-07-05 10:20:32 +02:00

105 lines
2.4 KiB
Nix

{ black
, blacken-docs
, fetchFromGitHub
, lib
, python3
, ruff
}:
python3.pkgs.buildPythonApplication rec {
pname = "nbqa";
version = "1.8.5";
pyproject = true;
src = fetchFromGitHub {
owner = "nbQA-dev";
repo = "nbQA";
rev = "refs/tags/${version}";
hash = "sha256-vRJxpWs2i4A8gi8F4YrTlmgBSnA73KeMCrmjLNF1zpA=";
};
build-system = with python3.pkgs; [
setuptools
];
passthru.optional-dependencies = {
black = [ black ];
blacken-docs = [ blacken-docs ];
flake8 = [ python3.pkgs.flake8 ];
isort = [ python3.pkgs.isort ];
jupytext = [ python3.pkgs.jupytext ];
mypy = [ python3.pkgs.mypy ];
pylint = [ python3.pkgs.pylint ];
pyupgrade = [ python3.pkgs.pyupgrade ];
ruff = [ ruff ];
};
dependencies = with python3.pkgs;
[
autopep8
ipython
tokenize-rt
tomli
]
++ builtins.attrValues passthru.optional-dependencies;
postPatch = ''
# Force using the Ruff executable rather than the Python package
substituteInPlace nbqa/__main__.py --replace 'if shell:' 'if shell or main_command == "ruff":'
'';
preCheck = ''
# Allow the tests to run `nbqa` itself from the path
export PATH="$out/bin":"$PATH"
'';
nativeCheckInputs =
[
black
ruff
]
++ (with python3.pkgs; [
autoflake
flake8
isort
jupytext
mdformat
pre-commit-hooks
pydocstyle
pylint
pytestCheckHook
pyupgrade
yapf
]);
disabledTests = [
# Test data not found
"test_black_multiple_files"
"test_black_return_code"
"test_grep"
"test_jupytext_on_folder"
"test_mypy_works"
"test_running_in_different_dir_works"
"test_unable_to_reconstruct_message_pythonpath"
"test_with_subcommand"
"test_pylint_works"
# Test cases not updated to work with ruff>=0.5.0
# https://github.com/nbQA-dev/nbQA/issues/856
"test_ruff_works"
];
disabledTestPaths = [
# Test data not found
"tests/test_include_exclude.py"
];
meta = {
homepage = "https://github.com/nbQA-dev/nbQA";
changelog = "https://nbqa.readthedocs.io/en/latest/history.html";
description = "Run ruff, isort, pyupgrade, mypy, pylint, flake8, black, blacken-docs, and more on Jupyter Notebooks";
license = lib.licenses.mit;
maintainers = with lib.maintainers; [ l0b0 ];
mainProgram = "nbqa";
};
}