From 5f096364d5b26c5c6ed3e59c431eda6f5b694fa3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Wed, 7 Sep 2022 17:43:29 +0200
Subject: [PATCH] DOC: add to changelog, setup.py and docs
---
CHANGELOG.md | 4 ++++
setup.py | 1 +
src/doc/crawler.rst | 8 ++++++++
3 files changed, 13 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d950e343..4d371bd8 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ##
### Added ###
+- caosdbignore; You can add one or more `.caosdbignore` files to the directory
+ structure that you want to make available in CaosDB and the run loadFiles.
+ The syntax is that of `.gitignore` files. For more information see `loadFiles`
+ section of the Crawler in the documentation.
### Changed ###
diff --git a/setup.py b/setup.py
index e5803191..c0070482 100755
--- a/setup.py
+++ b/setup.py
@@ -162,6 +162,7 @@ def setup_package():
"xlrd>=2.0",
],
extras_require={"h5-crawler": ["h5py>=3.3.0", ],
+ "gitignore_parser ": ["gitignore_parser >=0.1.0", ],
},
packages=find_packages('src'),
package_dir={'': 'src'},
diff --git a/src/doc/crawler.rst b/src/doc/crawler.rst
index 4b99c97e..fe487c55 100644
--- a/src/doc/crawler.rst
+++ b/src/doc/crawler.rst
@@ -121,6 +121,14 @@ as seen by the CaosDB server (The actual path may vary. This is the used
in the LinkAhead distribution of CaosDB). In this case the root file
system as seen from within the CaosDB docker process is used.
+
+You can provide a `.caosdbignore` file as a commandline option to the above
+loadFiles command. The syntax of that file is the same as for `.gitignore`
+files. Note, that you can have additional `.caosdbignore` files at lower levels
+which are appended to the current ignore file and have an effect of the
+respective subtree.
+
+
Extending the Crawlers
======================
--
GitLab