index

index_fs async

index_fs(
    channel_directory,
    target_platform=None,
    repodata_patch=None,
    force=False,
    max_parallel=128,
)

Indexes dependencies in the channel_directory for one or more subdirectories within said directory. Will generate repodata.json files in each subdirectory containing metadata about each present package, or if target_platform is specified will only consider the subdirectory corresponding to this platform. Will always index the "noarch" subdirectory, and thus this subdirectory should always be present, because conda channels at a minimum must include this subdirectory.

Parameters:

Name	Type	Description	Default
channel_directory	PathLike[str]	A os.PathLike[str] that is the directory containing subdirectories of dependencies to index.	required
target_platform	Optional[Platform]	A Platform to index dependencies for.	None
repodata_patch	Optional[str]	The name of the conda package (expected to be in the noarch subdir) that should be used for repodata patching.	None
force	bool	Whether to forcefully re-index all subdirs.	False
max_parallel	int	The maximum number of packages to process in-memory simultaneously.	128

index_s3 async

index_s3(
    channel_url,
    region,
    endpoint_url,
    force_path_style=False,
    access_key_id=None,
    secret_access_key=None,
    session_token=None,
    target_platform=None,
    repodata_patch=None,
    force=False,
    max_parallel=128,
)

Indexes dependencies in the channel_url for one or more subdirectories in the S3 directory. Will generate repodata.json files in each subdirectory containing metadata about each present package, or if target_platform is specified will only consider the subdirectory corresponding to this platform. Will always index the "noarch" subdirectory, and thus this subdirectory should always be present, because conda channels at a minimum must include this subdirectory.

Parameters:

Name	Type	Description	Default
channel_url	str	An S3 URL (e.g., s3://my-bucket/my-channel that containins the subdirectories of dependencies to index.	required
region	str	The region of the S3 bucket.	required
endpoint_url	str	The endpoint URL of the S3 bucket.	required
force_path_style	bool	Whether to use path-style addressing for S3.	False
access_key_id	Optional[str]	The access key ID to use for authentication.	None
secret_access_key	Optional[str]	The secret access key to use for authentication.	None
session_token	Optional[str]	The session token to use for authentication.	None
target_platform	Optional[Platform]	A Platform to index dependencies for.	None
repodata_patch	Optional[str]	The name of the conda package (expected to be in the noarch subdir) that should be used for repodata patching.	None
force	bool	Whether to forcefully re-index all subdirs.	False
max_parallel	int	The maximum number of packages to process in-memory simultaneously.	128