about summary refs log tree commit diff
path: root/pkgs/development/python-modules/mkdocs-rss-plugin/default.nix
diff options
context:
space:
mode:
Diffstat (limited to 'pkgs/development/python-modules/mkdocs-rss-plugin/default.nix')
-rw-r--r--pkgs/development/python-modules/mkdocs-rss-plugin/default.nix69
1 files changed, 69 insertions, 0 deletions
diff --git a/pkgs/development/python-modules/mkdocs-rss-plugin/default.nix b/pkgs/development/python-modules/mkdocs-rss-plugin/default.nix
new file mode 100644
index 0000000000000..5328c196c31e3
--- /dev/null
+++ b/pkgs/development/python-modules/mkdocs-rss-plugin/default.nix
@@ -0,0 +1,69 @@
+{
+  lib,
+  buildPythonPackage,
+  feedparser,
+  fetchFromGitHub,
+  gitpython,
+  jsonfeed,
+  mkdocs,
+  pytestCheckHook,
+  pythonOlder,
+  setuptools,
+  validator-collection,
+}:
+
+buildPythonPackage rec {
+  pname = "mkdocs-rss-plugin";
+  version = "1.12.1";
+  pyproject = true;
+
+  disabled = pythonOlder "3.9";
+
+  src = fetchFromGitHub {
+    owner = "Guts";
+    repo = "mkdocs-rss-plugin";
+    rev = "refs/tags/${version}";
+    hash = "sha256-cLQfhMYW/9Eb+IamQIC7fZRTm/ORD8xbcrmKkSkUrMs=";
+  };
+
+  postPatch = ''
+    sed -i "/--cov/d" setup.cfg
+  '';
+
+  build-system = [ setuptools ];
+
+  dependencies = [
+    gitpython
+    mkdocs
+  ];
+
+  nativeCheckInputs = [
+    feedparser
+    jsonfeed
+    pytestCheckHook
+    validator-collection
+  ];
+
+  pythonImportsCheck = [ "mkdocs_rss_plugin" ];
+
+  disabledTests = [
+    # Tests require network access
+    "test_plugin_config_through_mkdocs"
+    "test_remote_image_ok"
+  ];
+
+  disabledTestPaths = [
+    # Tests require network access
+    "tests/test_integrations_material_social_cards.py"
+    "tests/test_build_no_git.py"
+    "tests/test_build.py"
+  ];
+
+  meta = with lib; {
+    description = "MkDocs plugin to generate a RSS feeds for created and updated pages, using git log and YAML frontmatter";
+    homepage = "https://github.com/Guts/mkdocs-rss-plugin";
+    changelog = "https://github.com/Guts/mkdocs-rss-plugin/blob/${src.rev}/CHANGELOG.md";
+    license = licenses.mit;
+    maintainers = with maintainers; [ fab ];
+  };
+}