Page Menu
Home
Software Heritage
Search
Configure Global Search
Log In
Files
F9749467
D5131.id.diff
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Flag For Later
Size
2 KB
Subscribers
None
D5131.id.diff
View Options
diff --git a/README.md b/README.md
--- a/README.md
+++ b/README.md
@@ -1,23 +1,25 @@
swh-loader-svn
==============
-Documents are in the ./docs folder:
-- Specification: ./docs/swh-loader-svn.txt
+The Software Heritage SVN Loader is a tool and a library to walk a remote svn repository
+and inject into the SWH dataset all contained files that weren't known before.
-# Configuration file
+The main entry points are
-## Location
+- :class:`swh.loader.svn.SvnLoader` for the main svn loader which ingests content out of
+ a remote svn repository
-Either:
-- /etc/softwareheritage/
-- ~/.config/swh/
-- ~/.swh/
+- :class:`swh.loader.svn.SvnLoaderFromDumpArchive` which mounts a repository out of a
+ svn dump prior to ingest it.
-Note: Will call that location $SWH_CONFIG_PATH
+- :class:`swh.loader.svn.SvnLoaderFromRemoteDump` which mounts a repository with
+ svnrdump prior to ingest its content.
-## Configuration sample
+# CLI run
-$SWH_CONFIG_PATH/loader/svn.yml:
+With the configuration:
+
+/tmp/loader_svn.yml:
```
storage:
cls: remote
@@ -25,47 +27,9 @@
url: http://localhost:5002/
```
-## Local run
-
-### local svn repository
-
-```
-$ python3
-repo = 'pyang-repo-r343-eol-native-mixed-lf-crlf'
-#repo = 'zipeg-gae'
-origin_url = 'http://%s.googlecode.com' % repo
-local_repo_path = '/home/storage/svn/repo'
-svn_url = 'file://%s/%s' % (local_repo_path, repo)
-
-import logging
-logging.basicConfig(level=logging.DEBUG)
-
-from swh.loader.svn.tasks import LoadSvnRepository
-
-t = LoadSvnRepository()
-t.run(svn_url=svn_url,
- origin_url=origin_url, visit_date='2016-05-03T15:16:32+00:00',
- start_from_scratch=True)
-```
-
-### Mount and load an archive repository dump
+Run:
```
-$ python3
-repo = '0-512-md'
-archive_name = '%s-repo.svndump.gz' % repo
-archive_path = '/home/storage/svn/dumps/%s' % archive_name
-origin_url = 'http://%s.googlecode.com' % repo
-svn_url = 'file://%s' % repo
-
-import logging
-logging.basicConfig(level=logging.DEBUG)
-
-from swh.loader.svn.tasks import MountAndLoadSvnRepository
-
-t = MountAndLoadSvnRepository()
-t.run(archive_path=archive_path,
- origin_url=origin_url,
- visit_date='2016-05-03T15:16:32+00:00',
- start_from_scratch=True)
+swh loader --config-file /tmp/loader_svn.yml \
+ run svn <svn-repository-url>
```
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Sun, Aug 24, 5:30 PM (5 d, 3 h ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3228569
Attached To
D5131: svn.loader: README: Update to a minimum
Event Timeline
Log In to Comment