Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-advanced-user-tools
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
caosdb
Software
caosdb-advanced-user-tools
Commits
9029b530
Commit
9029b530
authored
3 years ago
by
Daniel Hornung
Browse files
Options
Downloads
Patches
Plain Diff
DOC: Updated documentation a bit.
parent
27d59126
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!4
MAINT: be more specific with output
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
README_SETUP.md
+1
-1
1 addition, 1 deletion
README_SETUP.md
integrationtests/crawl.py
+1
-1
1 addition, 1 deletion
integrationtests/crawl.py
integrationtests/extroot/.create_dir
+0
-0
0 additions, 0 deletions
integrationtests/extroot/.create_dir
src/doc/crawler.rst
+9
-5
9 additions, 5 deletions
src/doc/crawler.rst
with
11 additions
and
7 deletions
README_SETUP.md
+
1
−
1
View file @
9029b530
...
...
@@ -34,7 +34,7 @@ For testing:
3.
Start an empty (!) CaosDB instance (with the mounted extroot). The
database will be cleared during testing, so it's important to use
an empty instance.
4.
Run
`test.sh`
.
4.
Run
`test.sh`
.
Note that this may modify content of the
`integrationtest/extroot/`
directory.
## Code Formatting
`autopep8 -i -r ./`
...
...
This diff is collapsed.
Click to expand it.
integrationtests/crawl.py
+
1
−
1
View file @
9029b530
...
...
@@ -43,7 +43,7 @@ except ModuleNotFoundError:
return
argparse
.
ArgumentParser
()
def
print_success
(
text
):
print
(
"
Success:
"
+
text
)
print
(
"
Success:
"
+
text
)
def
get_parser
():
...
...
This diff is collapsed.
Click to expand it.
integrationtests/extroot/.c
e
rate_dir
→
integrationtests/extroot/.cr
e
ate_dir
+
0
−
0
View file @
9029b530
File moved
This diff is collapsed.
Click to expand it.
src/doc/crawler.rst
+
9
−
5
View file @
9029b530
...
...
@@ -75,7 +75,7 @@ The crawler can be executed directly via a python script (usually called
``crawl.py``). The script prints the progress and reports potential
problems. The exact behavior depends on your setup. However, you can
have a look at the example in the
`tests <https://gitlab.com/caosdb/caosdb-advanced-user-tools/-/blob/main/integrationtests/
full_test/
crawl.py>`__.
`tests <https://gitlab.
indiscale.
com/caosdb/
src/
caosdb-advanced-user-tools/-/blob/main/integrationtests/crawl.py>`__.
.. Note:: The crawler depends on the CaosDB Python client, so make sure to install :doc:`pycaosdb
<caosdb-pylib:getting_started>`.
...
...
@@ -86,14 +86,18 @@ Typically, an invocation looks like:
.. code:: python
python3 crawl.py
"/TestData/"
python3 crawl.py
/someplace/
In this case ``/TestData/`` identifies the path to be crawled **within
the CaosDB file system**. You can browse the CaosDB file system by
.. Note:: For trying this out with the above mentioned example crawler from the integration tests,
make sure that the ``extroot`` directory in the ``integrationtests`` folder is used as
CaosDB's extroot directory,and call the crawler with ``python3 crawl.py /``.
In this case ``/someplace/`` identifies the path to be crawled **within
CaosDB's file system**. You can browse the CaosDB file system by
opening the WebUI of your CaosDB instance and clicking on “File System”.
In the backend, ``crawl.py`` starts a CQL query
``FIND File WHICH IS STORED AT /
TestData
/**`` and crawls the resulting
``FIND File WHICH IS STORED AT /
someplace
/**`` and crawls the resulting
files according to your customized ``CFoods``.
Crawling may consist of two distinct steps: 1. Insertion of files (use
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment