Skip to main content
Ctrl
+
K
Site Navigation
Development
API reference
Usage
Infrastructure
GitLab
PyPI
System Status
Site Navigation
Development
API reference
Usage
Infrastructure
GitLab
PyPI
System Status
Section Navigation
Getting started
Run your own Software Heritage
Developer setup
Docker environment
Getting Started with the Software Heritage API
Software Architecture
Software Architecture Overview
Metadata workflow and architecture
Contributing
Important
Code Review
Python style guide
Git style guide
Sphinx gotchas
Tutorial: Best practices when writing SWH docs
Tutorials
Software testing guide
Issue debugging and monitoring guide
Add a new package
Frequently Asked Questions
Roadmap 2022
Current and past roadmaps
Roadmap 2022
Roadmap 2021
API reference
swh.auth
Command-line interface
Django components
swh.core
Command-line interface
Common database utilities
swh.counters
swh.dataset
Software Heritage Graph Dataset
Dataset
Relational schema
Setup on Amazon Athena
Setup on Azure Databricks
Exporting a dataset
Exporting a subdataset
swh.deposit
Deposit API
User Manual
API Documentation
Deposit metadata
Use cases
Register account
Deposit internals
Running swh-deposit locally
Production deployment
Authentication
Loading workflow
Specifications
Loading specification
Protocol reference
The metadata-only deposit
Command-line interface
swh.fuse
Command-line interface
Configuration
Design notes
Tutorial
swh.graph
Quickstart
Graph Querying HTTP API
Using the GRPC API
Using the Java API
Memory & Performance tuning
Graph compression
Command-line interface
Docker environment
git2graph
swh.graphql
swh.indexer
swh-indexer
Hacking on swh-indexer
Metadata workflow
Command-line interface
swh.journal
Software Heritage Journal clients
swh.lister
Tutorial: list the content of your favorite forge in just a few steps
Tutorial: run a lister within docker-dev in just a few steps
Save a forge
Command-line interface
swh.loader
swh.loader.core
VCS Loader Overview
Package Loader Tutorial
Package loader specifications
Command-line interface
swh.loader.bzr
Software Heritage - How Bazaar/Breezy works
Software Heritage - CVS loader
swh.loader.git
swh.loader.mercurial
swh.loader.metadata
swh.loader.svn
swh.model
Data model
SoftWare Heritage persistent IDentifiers (SWHIDs)
Command-line interface
swh.objstorage
Command-line interface
Winery backend
swh.objstorage.replayer
Command-line interface
swh.perfecthash
Benchmarks
Read Shard format
swh.scanner
Command-line interface
swh.scheduler
Command-line interface
Software Heritage Scheduler Simulator
swh.scrubber
swh.search
Command-line interface
Search Query Language
swh.storage
Command-line interface
swh.vault
Getting started
Vault API Reference
Command-line interface
swh.web
Developers Information
swh-web API URLs
URI scheme for swh-web Browse application
URI scheme for SoftWare Heritage IDentifiers (SWHIDs)
Miscellaneous URLs
swh.web.client
Archive ChangeLog
Journal Specification
Statsd metrics and Grafana dashboards
Tutorials
#
Software testing guide
Issue debugging and monitoring guide
Add a new package
Edit this page
Show Source