Metadata-Version: 2.1
Name: swh.journal
Version: 1.3.1
Summary: Software Heritage Journal utilities
Home-page: https://forge.softwareheritage.org/diffusion/DJNL/
Author: Software Heritage developers
Author-email: swh-devel@inria.fr
Project-URL: Bug Reports, https://forge.softwareheritage.org/maniphest
Project-URL: Funding, https://www.softwareheritage.org/donate
Project-URL: Source, https://forge.softwareheritage.org/source/swh-journal
Project-URL: Documentation, https://docs.softwareheritage.org/devel/swh-journal/
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: testing
License-File: LICENSE
License-File: AUTHORS

swh-journal
===========

Persistent logger of changes to the archive, with publish-subscribe support.

See the
[documentation](https://docs.softwareheritage.org/devel/swh-journal/index.html#software-heritage-journal)
for more details.

# Local test

Provided you are in the right virtual environment as described
in the [swh getting-started](https://docs.softwareheritage.org/devel/developer-setup.html#developer-setup):

```
pytest
```

or:

```
tox
```


# Running

## publisher

Command:
```
$ swh-journal --config-file ~/.config/swh/journal/publisher.yml \
              publisher
```

# Auto-completion

To have the completion, add the following in your
~/.virtualenvs/swh/bin/postactivate:

```
eval "$(_SWH_JOURNAL_COMPLETE=$autocomplete_cmd swh-journal)"
```
