diff --git a/docs/index.rst b/docs/index.rst index b02da3b..9d06f64 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,157 +1,162 @@ .. _swh-docs: Software Heritage - Development Documentation ============================================= Getting started --------------- * :ref:`getting-started` ← start here to get your own Software Heritage platform running in less than 5 minutes, or * :ref:`developer-setup` ← here to hack on the Software Heritage software stack Architecture ------------ * :ref:`architecture` ← go there to have a glimpse on the Software Heritage software architecture Components ---------- Here is brief overview of the most relevant software components in the Software Heritage stack. Each component name is linked to the development documentation of the corresponding Python module. :ref:`swh.core ` low-level utilities and helpers used by almost all other modules in the stack :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-git ` loader for `Git `_ repositories :ref:`swh.loader-mercurial ` loader for `Mercurial `_ repositories :ref:`swh.loader-svn ` loader for `Subversion `_ 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.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.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). 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: architecture getting-started developer-setup Infrastructure API documentation swh.core swh.dataset swh.deposit + swh.fuse swh.graph swh.indexer swh.journal swh.lister swh.loader swh.model swh.objstorage swh.scanner swh.scheduler swh.storage swh.vault swh.web swh.web.client diff --git a/requirements-swh-dev.txt b/requirements-swh-dev.txt index 5c4f997..9fe26ea 100644 --- a/requirements-swh-dev.txt +++ b/requirements-swh-dev.txt @@ -1,24 +1,25 @@ # 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). ../swh-core[http,db,logging] ../swh-model ../swh-journal ../swh-objstorage[testing] ../swh-storage[schemata] ../swh-objstorage-replayer ../swh-scheduler ../swh-deposit ../swh-graph ../swh-icinga-plugins ../swh-indexer ../swh-lister ../swh-loader-core ../swh-loader-git ../swh-loader-mercurial ../swh-loader-svn ../swh-search ../swh-vault ../swh-web ../swh-web-client ../swh-scanner +../swh-fuse diff --git a/requirements-swh.txt b/requirements-swh.txt index 97bf67e..1c7cad0 100644 --- a/requirements-swh.txt +++ b/requirements-swh.txt @@ -1,20 +1,21 @@ # Add here internal Software Heritage dependencies, one per line. swh.core[db,http] swh.deposit +swh.fuse swh.graph swh.indexer swh.journal swh.lister swh.loader.core swh.loader.git swh.loader.mercurial swh.loader.svn swh.model swh.objstorage[testing] swh.objstorage.replayer swh.scanner swh.scheduler swh.storage[schemata] swh.vault swh.web swh.web.client