config.py
View Options

	# Copyright (C) 2017-2020 The Software Heritage developers
	# See the AUTHORS file at the top-level directory of this distribution
	# License: GNU General Public License version 3, or any later version
	# See top-level LICENSE file for more information

	import os
	from typing import Any, Dict

	from swh.core import config
	from swh.deposit import __version__
	from swh.scheduler import get_scheduler
	from swh.scheduler.interface import SchedulerInterface
	from swh.storage import get_storage
	from swh.storage.interface import StorageInterface

	# IRIs (Internationalized Resource identifier) sword 2.0 specified
	EDIT_IRI = "edit_iri"
	SE_IRI = "se_iri"
	EM_IRI = "em_iri"
	CONT_FILE_IRI = "cont_file_iri"
	SD_IRI = "servicedocument"
	COL_IRI = "upload"
	STATE_IRI = "state_iri"
	PRIVATE_GET_RAW_CONTENT = "private-download"
	PRIVATE_CHECK_DEPOSIT = "check-deposit"
	PRIVATE_PUT_DEPOSIT = "private-update"
	PRIVATE_GET_DEPOSIT_METADATA = "private-read"
	PRIVATE_LIST_DEPOSITS = "private-deposit-list"

	ARCHIVE_KEY = "archive"
	METADATA_KEY = "metadata"
	RAW_METADATA_KEY = "raw-metadata"

	ARCHIVE_TYPE = "archive"
	METADATA_TYPE = "metadata"


	AUTHORIZED_PLATFORMS = ["development", "production", "testing"]

	DEPOSIT_STATUS_REJECTED = "rejected"
	DEPOSIT_STATUS_PARTIAL = "partial"
	DEPOSIT_STATUS_DEPOSITED = "deposited"
	DEPOSIT_STATUS_VERIFIED = "verified"
	DEPOSIT_STATUS_LOAD_SUCCESS = "done"
	DEPOSIT_STATUS_LOAD_FAILURE = "failed"

	# Revision author for deposit
	SWH_PERSON = {
	"name": "Software Heritage",
	"fullname": "Software Heritage",
	"email": "robot@softwareheritage.org",
	}


	DEFAULT_CONFIG = {
	"max_upload_size": 209715200,
	"checks": True,
	}


	def setup_django_for(platform=None, config_file=None):
	"""Setup function for command line tools (swh.deposit.create_user) to
	initialize the needed db access.

	Note:
	Do not import any django related module prior to this function
	call. Otherwise, this will raise an
	django.core.exceptions.ImproperlyConfigured error message.

	Args:
	platform (str): the platform the scheduling is running
	config_file (str): Extra configuration file (typically for the
	production platform)

	Raises:
	ValueError in case of wrong platform inputs.

	"""
	if platform is not None:
	if platform not in AUTHORIZED_PLATFORMS:
	raise ValueError("Platform should be one of %s" % AUTHORIZED_PLATFORMS)
	if "DJANGO_SETTINGS_MODULE" not in os.environ:
	os.environ["DJANGO_SETTINGS_MODULE"] = "swh.deposit.settings.%s" % platform

	if config_file:
	os.environ.setdefault("SWH_CONFIG_FILENAME", config_file)

	import django

	django.setup()


	class APIConfig:
	"""API Configuration centralized class. This loads explicitly the configuration file out
	of the SWH_CONFIG_FILENAME environment variable.

	"""

	def __init__(self):
	self.config: Dict[str, Any] = config.load_from_envvar(DEFAULT_CONFIG)
	self.scheduler: SchedulerInterface = get_scheduler(**self.config["scheduler"])
	self.tool = {
	"name": "swh-deposit",
	"version": __version__,
	"configuration": {"sword_version": "2"},
	}
	self.storage_metadata: StorageInterface = get_storage(
	**self.config["storage_metadata"]
	)

File Metadata

Mime Type: text/x-python
Expires: Jul 4 2025, 9:51 AM (5 w, 1 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 3362619

config.py
No OneTemporary
Actions

config.py
View Options

File Metadata

Event Timeline

config.pyNo OneTemporaryActions

config.pyView Options

File Metadata

Event Timeline

config.py
No OneTemporary
Actions

config.py
View Options