Changeset View
Changeset View
Standalone View
Standalone View
README.md
swh-storage | swh-storage | ||||
=========== | =========== | ||||
Abstraction layer over the archive, allowing to access all stored source code | Abstraction layer over the archive, allowing to access all stored source code | ||||
artifacts as well as their metadata. | artifacts as well as their metadata. | ||||
See the | See the | ||||
[documentation](https://docs.softwareheritage.org/devel/swh-storage/index.html) | [documentation](https://docs.softwareheritage.org/devel/swh-storage/index.html) | ||||
for more details. | for more details. | ||||
## Quick start | ## Quick start | ||||
### Dependencies | ### Dependencies | ||||
Python tests for this module include tests that cannot be run without | Python tests for this module include tests that cannot be run without a local | ||||
a local Postgresql database, so you need the Postgresql server executable on | Postgresql database, so you need the Postgresql server executable on your | ||||
your machine (no need to have a running Postgresql server). On a Debian-like | machine (no need to have a running Postgresql server). They also expect a | ||||
host: | cassandra server. | ||||
#### Debian-like host | |||||
``` | |||||
ardumont: heads up, I changed to `postgresql-11` as current debian stable does not show a `postgresql`… | |||||
$ sudo apt install libpq-dev postgresql-11 cassandra | |||||
``` | |||||
#### Non Debian-like host | |||||
The tests expects `/usr/sbin/cassandra` to exist. | |||||
Optionally, you can avoid running the cassandra tests. | |||||
``` | ``` | ||||
$ sudo apt install libpq-dev postgresql | (swh) :~/swh-storage$ tox -- -m 'not cassandra' | ||||
``` | ``` | ||||
### Installation | ### Installation | ||||
It is strongly recommended to use a virtualenv. In the following, we | It is strongly recommended to use a virtualenv. In the following, we | ||||
Done Inline Actionsardumont: https://forge.softwareheritage.org/source/swh-storage/browse/master/swh/storage/tests/test_cass… | |||||
Done Inline Actions/me *sighs* this comment was attached to the hardcoded /usr/sbin/cassandra/ expectations... ardumont: /me *sighs* this comment was attached to the hardcoded `/usr/sbin/cassandra/` expectations... | |||||
consider you work in a virtualenv named `swh`. See the | consider you work in a virtualenv named `swh`. See the | ||||
[developer setup guide](https://docs.softwareheritage.org/devel/developer-setup.html#developer-setup) | [developer setup guide](https://docs.softwareheritage.org/devel/developer-setup.html#developer-setup) | ||||
for a more details on how to setup a working environment. | for a more details on how to setup a working environment. | ||||
You can install the package directly from | You can install the package directly from | ||||
[pypi](https://pypi.org/p/swh.storage): | [pypi](https://pypi.org/p/swh.storage): | ||||
▲ Show 20 Lines • Show All 146 Lines • Show Last 20 Lines |
heads up, I changed to postgresql-11 as current debian stable does not show a postgresql package.