diff --git a/docs/api-reference.rst b/docs/api-reference.rst index 3bbe87a..f3fa399 100644 --- a/docs/api-reference.rst +++ b/docs/api-reference.rst @@ -1,30 +1,31 @@ .. _api-reference: API reference ============= .. toctree:: :maxdepth: 2 swh.auth swh.core swh.counters swh.dataset swh.deposit swh.fuse swh.graph swh.indexer swh.journal swh.lister swh.loader swh.model swh.objstorage swh.objstorage.replayer swh.perfecthash swh.scanner swh.scheduler + swh.scrubber swh.search swh.storage swh.vault swh.web swh.web.client diff --git a/docs/index.rst b/docs/index.rst index 4c4b00d..799b076 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,221 +1,225 @@ .. _swh-docs: Software Heritage - Development Documentation ============================================= Getting started --------------- * :ref:`getting-started` → deploy a local copy of the Software Heritage software stack in less than 5 minutes, or * :ref:`developer-setup` → get a working development setup that allows to hack on the Software Heritage software stack * :ref:`faq` Contributing ------------ * :ref:`patch-submission` → learn how to submit your patches to the Software Heritage codebase * :ref:`code-review` → rules and guidelines to review code in Software Heritage * :ref:`python-style-guide` → how to format the Python code you write Architecture ------------ * :ref:`architecture-overview` → get a glimpse of the Software Heritage software architecture * :ref:`Metadata workflow ` → learn how Software Heritage stores and handles metadata Data Model and Specifications ----------------------------- * :ref:`persistent-identifiers` Specifications of the SoftWare Heritage persistent IDentifiers (SWHID). * :ref:`data-model` Documentation of the main |swh| archive data model. * :ref:`journal-specs` Documentation of the Kafka journal of the |swh| archive. Tutorials --------- * :ref:`testing-guide` * :doc:`/tutorials/issue-debugging-monitoring` * :ref:`Listing the content of your favorite forge ` and :ref:`running a lister in Docker ` * :ref:`Add a new swh package ` * :ref:`doc-contribution` Roadmap ------- * :ref:`roadmap-2021` System Administration --------------------- * :ref:`Network Infrastructure ` * :ref:`swh-sysadm:mirror` → learn what a Software Heritage mirror is and how to set up one * :ref:`Keycloak ` → learn how to use Keycloak, the authentication system used by |swh|'s web interface and public APIs Components ---------- Here is brief overview of the most relevant software components in the Software Heritage stack, in alphabetical order. For a better introduction to the architecture, see the :ref:`architecture-overview`, which presents each of them in a didactical order. Each component name is linked to the development documentation of the corresponding Python module. :ref:`swh.auth ` low-level library used by modules needing keycloak authentication :ref:`swh.core ` low-level utilities and helpers used by almost all other modules in the stack :ref:`swh.counters ` service providing efficient estimates of the number of objects in the SWH archive, using Redis's Hyperloglog :ref:`swh.dataset ` public datasets and periodic data dumps of the archive released by Software Heritage :ref:`swh.deposit ` push-based deposit of software artifacts to the archive swh.docs developer documentation (used to generate this doc you are reading) :ref:`swh.fuse ` Virtual file system to browse the Software Heritage archive, based on `FUSE `_ :ref:`swh.graph ` Fast, compressed, in-memory representation of the archive, with tooling to generate and query it. :ref:`swh.indexer ` tools and workers used to crawl the content of the archive and extract derived information from any artifact stored in it :ref:`swh.journal ` persistent logger of changes to the archive, with publish-subscribe support :ref:`swh.lister ` collection of listers for all sorts of source code hosting and distribution places (forges, distributions, package managers, etc.) :ref:`swh.loader-core ` low-level loading utilities and helpers used by all other loaders :ref:`swh.loader-bzr ` loader for `Bazaar `_ and `Breezy `_ repositories :ref:`swh.loader-git ` loader for `Git `_ repositories :ref:`swh.loader-mercurial ` loader for `Mercurial `_ repositories :ref:`swh.loader-svn ` loader for `Subversion `_ repositories :ref:`swh.loader-cvs ` loader for `CVS `_ repositories :ref:`swh.model ` implementation of the :ref:`data-model` to archive source code artifacts :ref:`swh.objstorage ` content-addressable object storage :ref:`swh.objstorage.replayer ` Object storage replication tool :ref:`swh.perfecthash ` Low level management for read-only content-addressable object storage indexed with a perfect hash table :ref:`swh.scanner ` source code scanner to analyze code bases and compare them with source code artifacts archived by Software Heritage :ref:`swh.scheduler ` task manager for asynchronous/delayed tasks, used for recurrent (e.g., listing a forge, loading new stuff from a Git repository) and one-off activities (e.g., loading a specific version of a source package) +:ref:`swh.scrubber ` + Tooling to check integrity of various data stores (swh.journal, swh.objstorage, + swh.storage) and fix corrupt objects they contain. + :ref:`swh.search ` search engine for the archive :ref:`swh.storage ` abstraction layer over the archive, allowing to access all stored source code artifacts as well as their metadata :ref:`swh.vault ` implementation of the vault service, allowing to retrieve parts of the archive as self-contained bundles (e.g., individual releases, entire repository snapshots, etc.) :ref:`swh.web ` Web application(s) to browse the archive, for both interactive (HTML UI) and mechanized (REST API) use :ref:`swh.web.client ` Python client for :ref:`swh.web ` Dependencies ------------ The dependency relationships among the various modules are depicted below. .. _py-deps-swh: .. figure:: images/py-deps-swh.svg :width: 1024px :align: center Dependencies among top-level Python modules (click to zoom). Archive ------- * :ref:`Archive ChangeLog `: notable changes to the archive over time Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * `URLs index `_ * :ref:`search` * :ref:`glossary` .. ensure sphinx does not complain about index files not being included .. toctree:: :maxdepth: 2 :caption: Contents: :titlesonly: :hidden: getting-started/index architecture/index contributing/index tutorials/index faq/index roadmap/roadmap-2021 api-reference archive-changelog journal diff --git a/requirements-swh-dev.txt b/requirements-swh-dev.txt index 749b322..0552167 100644 --- a/requirements-swh-dev.txt +++ b/requirements-swh-dev.txt @@ -1,33 +1,34 @@ # Add here internal Software Heritage dependencies, one per line. # Dependencies need to be ordered in a way that ensure only # development versions will be used (not the release ones hosted on PyPI). # # This is NOT in alphabetical order ../swh-core[http,db,logging] ../swh-auth[django] ../swh-model ../swh-journal ../swh-counters ../swh-objstorage[testing] ../swh-storage ../swh-objstorage-replayer ../swh-scheduler[simulator] ../swh-deposit ../swh-graph ../swh-icinga-plugins ../swh-indexer ../swh-lister ../swh-loader-core ../swh-loader-bzr ../swh-loader-git ../swh-loader-mercurial ../swh-loader-svn ../swh-loader-cvs ../swh-perfecthash +../swh-scrubber ../swh-search ../swh-vault ../swh-web ../swh-web-client ../swh-scanner ../swh-fuse diff --git a/requirements-swh.txt b/requirements-swh.txt index c61d04b..56aef39 100644 --- a/requirements-swh.txt +++ b/requirements-swh.txt @@ -1,27 +1,28 @@ # Add here internal Software Heritage dependencies, one per line. swh.auth[django] swh.core[db,http,logging] swh.counters swh.deposit[server] swh.fuse swh.graph swh.indexer swh.journal swh.lister swh.loader.core swh.loader.bzr swh.loader.git swh.loader.mercurial swh.loader.svn swh.loader.cvs swh.model swh.objstorage[testing] swh.objstorage.replayer swh.perfecthash swh.scanner swh.scheduler[simulator] +swh.scrubber swh.search swh.storage swh.vault swh.web swh.web.client