README.rst
No OneTemporary
Actions

Size

811 B

Subscribers

None

README.rst
View Options

	Software Heritage - Web client
	==============================

	Client for Software Heritage Web applications, via their APIs.


	Sample usage
	------------

	.. code-block:: python

	from swh.web.client import WebAPIClient
	cli = WebAPIClient()

	# retrieve any archived object via its PID
	cli.get('swh:1:rev:aafb16d69fd30ff58afdd69036a26047f3aebdc6')

	# same, but for specific object types
	cli.revision('swh:1:rev:aafb16d69fd30ff58afdd69036a26047f3aebdc6')

	# get() always retrieve entire objects, following pagination
	# WARNING: this might not be what you want for large objects
	cli.get('swh:1:snp:6a3a2cf0b2b90ce7ae1cf0a221ed68035b686f5a')

	# type-specific methods support explicit iteration through pages
	next(cli.snapshot('swh:1:snp:cabcc7d7bf639bbe1cc3b41989e1806618dd5764'))