Software Heritage storage manager
Project description
swh-storage
Abstraction layer over the archive, allowing to access all stored source code artifacts as well as their metadata.
See the documentation for more details.
Quick start
Dependencies
Python tests for this module include tests that cannot be run without a local Postgresql database, so you need the Postgresql server executable on your machine (no need to have a running Postgresql server). On a Debian-like host:
$ sudo apt install libpq-dev postgresql
Installation
It is strongly recommended to use a virtualenv. In the following, we
consider you work in a virtualenv named swh. See the
developer setup guide
for a more details on how to setup a working environment.
You can install the package directly from pypi:
(swh) :~$ pip install swh.storage
[...]
Or from sources:
(swh) :~$ git clone https://forge.softwareheritage.org/source/swh-storage.git
[...]
(swh) :~$ cd swh-storage
(swh) :~/swh-storage$ pip install .
[...]
Then you can check it's properly installed:
(swh) :~$ swh storage --help
Usage: swh storage [OPTIONS] COMMAND [ARGS]...
Software Heritage Storage tools.
Options:
-h, --help Show this message and exit.
Commands:
rpc-serve Software Heritage Storage RPC server.
Tests
The best way of running Python tests for this module is to use tox.
(swh) :~$ pip install tox
tox
From the sources directory, simply use tox:
(swh) :~/swh-storage$ tox
[...]
========= 315 passed, 6 skipped, 15 warnings in 40.86 seconds ==========
_______________________________ summary ________________________________
flake8: commands succeeded
py3: commands succeeded
congratulations :)
Development
The storage server can be locally started. It requires a configuration file and a running Postgresql database.
Sample configuration
A typical configuration storage.yml file is:
storage:
cls: local
args:
db: "dbname=softwareheritage-dev user=<user> password=<pwd>"
objstorage:
cls: pathslicing
args:
root: /tmp/swh-storage/
slicing: 0:2/2:4/4:6
which means, this uses:
-
a local storage instance whose db connection is to
softwareheritage-devlocal instance, -
the objstorage uses a local objstorage instance whose:
-
rootpath is /tmp/swh-storage, -
slicing scheme is
0:2/2:4/4:6. This means that the identifier of the content (sha1) which will be stored on disk at first level with the first 2 hex characters, the second level with the next 2 hex characters and the third level with the next 2 hex characters. And finally the complete hash file holding the raw content. For example: 00062f8bd330715c4f819373653d97b3cd34394c will be stored at 00/06/2f/00062f8bd330715c4f819373653d97b3cd34394c
-
Note that the root path should exist on disk before starting the server.
Starting the storage server
If the python package has been properly installed (e.g. in a virtual env), you should be able to use the command:
(swh) :~/swh-storage$ swh storage rpc-serve storage.yml
This runs a local swh-storage api at 5002 port.
(swh) :~/swh-storage$ curl http://127.0.0.1:5002
<html>
<head><title>Software Heritage storage server</title></head>
<body>
<p>You have reached the
<a href="https://www.softwareheritage.org/">Software Heritage</a>
storage server.<br />
See its
<a href="https://docs.softwareheritage.org/devel/swh-storage/">documentation
and API</a> for more information</p>
And then what?
In your upper layer (loader-git, loader-svn, etc...), you can define a remote storage with this snippet of yaml configuration.
storage:
cls: remote
args:
url: http://localhost:5002/
You could directly define a local storage with the following snippet:
storage:
cls: local
args:
db: service=swh-dev
objstorage:
cls: pathslicing
args:
root: /home/storage/swh-storage/
slicing: 0:2/2:4/4:6
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file swh.storage-0.0.165.tar.gz.
File metadata
- Download URL: swh.storage-0.0.165.tar.gz
- Upload date:
- Size: 168.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
25ed856b15ed053e4889a3c462f14b41430c124c355706206ac4c03d0fc1bf3a
|
|
| MD5 |
ed512e0f7cd35015944fe1c57ed068cc
|
|
| BLAKE2b-256 |
7b8b9ded4c8ea259189624c1014139c8ee0a2fce37211eb4dca3491c17642104
|
File details
Details for the file swh.storage-0.0.165-py3-none-any.whl.
File metadata
- Download URL: swh.storage-0.0.165-py3-none-any.whl
- Upload date:
- Size: 141.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
508fa7c10b4666f124d80e2dc9f69baab076053792f54fdc392b831001dfbd21
|
|
| MD5 |
75615363e9db8d42ae0a8ff579bd2fb3
|
|
| BLAKE2b-256 |
2a46ae0a61c5a445457a9c1dd158c4b54cb2b56af215df3a910b382b02c2ea42
|
