ScanCode.io
latest
Getting Started
ScanCode.io Overview
Installation
User Interface
FAQs
Contributing to ScanCode.io
Changelog
Tutorial
Analyze Docker Image (Web UI)
Review Scan Results (Web UI)
Analyze Docker Image (Command Line)
Analyze Codebase (Command Line)
Analyse Package Archive (REST API)
License Policies and Compliance Alerts
Reference Documentation
ScanPipe Concepts
Built-in Pipelines
Custom Pipelines
Pipes
Data Models
Output Files
Command Line Interface
REST API
Application Settings
Recognized Distros, OS, and Images
ScanCode.io
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
_
__init__() (scanpipe.pipelines.Pipeline method)
(scanpipe.pipes.codebase.ProjectCodebase method)
(scanpipe.pipes.rootfs.RootFs method)
A
add_downloads() (scanpipe.models.Project method)
add_error() (scanpipe.models.Project method)
add_input_source() (scanpipe.models.Project method)
add_pipeline() (scanpipe.models.Project method)
add_uploads() (scanpipe.models.Project method)
add_webhook_subscription() (scanpipe.models.Project method)
analyze_compliance_licenses() (in module scanpipe.pipes.compliance)
analyze_scanned_files() (in module scanpipe.pipes)
(scanpipe.pipelines.root_filesystems.RootFS method)
append_to_log() (scanpipe.models.Run method)
archive() (scanpipe.models.Project method)
authors (scanpipe.models.CodebaseResource attribute)
B
bug_tracking_url (scanpipe.models.DiscoveredPackage attribute)
build_inventory_from_scan() (scanpipe.pipelines.scan_package.ScanPackage method)
build_inventory_from_scans() (scanpipe.pipelines.load_inventory.LoadInventory method)
C
can_add_input (scanpipe.models.Project attribute)
children() (scanpipe.models.CodebaseResource method)
clear_tmp_directory() (scanpipe.models.Project method)
code_view_url (scanpipe.models.DiscoveredPackage attribute)
codebase_path (scanpipe.models.Project property)
codebase_resources (scanpipe.models.DiscoveredPackage attribute)
CodebaseResource (class in scanpipe.models)
CodebaseResource.Compliance (class in scanpipe.models)
CodebaseResource.Type (class in scanpipe.models)
codebaseresources (scanpipe.models.Project attribute)
collect_and_create_codebase_resources() (scanpipe.pipelines.docker.Docker method)
(scanpipe.pipelines.root_filesystems.RootFS method)
(scanpipe.pipelines.scan_codebase.ScanCodebase method)
collect_and_create_system_packages() (scanpipe.pipelines.docker.Docker method)
(scanpipe.pipelines.root_filesystems.RootFS method)
collect_archive_information() (scanpipe.pipelines.scan_package.ScanPackage method)
collect_images_information() (scanpipe.pipelines.docker.Docker method)
collect_rootfs_information() (scanpipe.pipelines.root_filesystems.RootFS method)
compliance_alert (scanpipe.models.CodebaseResource attribute)
compute_compliance_alert() (scanpipe.models.CodebaseResource method)
contains_source_code (scanpipe.models.DiscoveredPackage attribute)
copy_input() (in module scanpipe.pipes.input)
copy_input_from() (scanpipe.models.Project method)
copy_inputs() (in module scanpipe.pipes.input)
copy_inputs_to_codebase_directory() (scanpipe.pipelines.scan_codebase.ScanCodebase method)
copyright (scanpipe.models.DiscoveredPackage attribute)
copyrights (scanpipe.models.CodebaseResource attribute)
count_group_by() (in module scanpipe.pipes)
create_and_add_package() (scanpipe.models.CodebaseResource method)
create_codebase_resources() (in module scanpipe.pipes.docker)
(in module scanpipe.pipes.rootfs)
(in module scanpipe.pipes.scancode)
create_discovered_packages() (in module scanpipe.pipes.scancode)
create_from_data() (scanpipe.models.DiscoveredPackage class method)
create_inventory_from_scan() (in module scanpipe.pipes.scancode)
created_date (scanpipe.models.Project attribute)
(scanpipe.models.ProjectError attribute)
(scanpipe.models.Run attribute)
D
declared_license (scanpipe.models.DiscoveredPackage attribute)
delete() (scanpipe.models.Project method)
dependencies (scanpipe.models.DiscoveredPackage attribute)
descendants() (scanpipe.models.CodebaseResource method)
description (scanpipe.models.DiscoveredPackage attribute)
(scanpipe.models.Run attribute)
details (scanpipe.models.ProjectError attribute)
DIRECTORY (scanpipe.models.CodebaseResource.Type attribute)
discovered_packages (scanpipe.models.CodebaseResource attribute)
DiscoveredPackage (class in scanpipe.models)
discoveredpackages (scanpipe.models.Project attribute)
DistroNotFound
DistroNotSupported
Docker (class in scanpipe.pipelines.docker)
DockerWindows (class in scanpipe.pipelines.docker_windows)
download_url (scanpipe.models.DiscoveredPackage attribute)
E
emails (scanpipe.models.CodebaseResource attribute)
ERROR (scanpipe.models.CodebaseResource.Compliance attribute)
error_count (scanpipe.models.Project attribute)
execute_task_async() (scanpipe.models.Run method)
extension (scanpipe.models.CodebaseResource attribute)
extra_data (scanpipe.models.CodebaseResource attribute)
(scanpipe.models.DiscoveredPackage attribute)
(scanpipe.models.Project attribute)
extract_archive() (in module scanpipe.pipes.scancode)
extract_archive_to_codebase_directory() (scanpipe.pipelines.scan_package.ScanPackage method)
extract_archives() (in module scanpipe.pipes.scancode)
(scanpipe.pipelines.scan_codebase.ScanCodebase method)
extract_image_from_tarball() (in module scanpipe.pipes.docker)
extract_images() (scanpipe.pipelines.docker.Docker method)
extract_images_from_inputs() (in module scanpipe.pipes.docker)
extract_input_files_to_codebase_directory() (scanpipe.pipelines.root_filesystems.RootFS method)
extract_layers() (scanpipe.pipelines.docker.Docker method)
extract_layers_from_images() (in module scanpipe.pipes.docker)
extract_layers_from_images_to_base_path() (in module scanpipe.pipes.docker)
extract_purl_data() (scanpipe.models.DiscoveredPackage class method)
F
fetch_docker_image() (in module scanpipe.pipes.fetch)
fetch_http() (in module scanpipe.pipes.fetch)
fetch_urls() (in module scanpipe.pipes.fetch)
FetchDockerImageError
FILE (scanpipe.models.CodebaseResource.Type attribute)
file_content (scanpipe.models.CodebaseResource property)
file_count (scanpipe.models.Project attribute)
file_in_package_count (scanpipe.models.Project attribute)
file_not_in_package_count (scanpipe.models.Project attribute)
file_type (scanpipe.models.CodebaseResource attribute)
filename (scanpipe.models.DiscoveredPackage attribute)
filename_now() (in module scanpipe.pipes)
find_images_os_and_distro() (scanpipe.pipelines.docker.Docker method)
find_root_filesystems() (scanpipe.pipelines.root_filesystems.RootFS method)
for_packages (scanpipe.models.CodebaseResource property)
from_project_codebase() (scanpipe.pipes.rootfs.RootFs class method)
G
get_bin_executable() (in module scanpipe.pipes)
get_compliance_alert_display() (scanpipe.models.CodebaseResource method)
get_doc() (scanpipe.pipelines.Pipeline class method)
get_docker_image_platform() (in module scanpipe.pipes.fetch)
get_graph() (scanpipe.pipelines.Pipeline class method)
get_image_data() (in module scanpipe.pipes.docker)
get_info() (scanpipe.pipelines.Pipeline class method)
get_installed_packages() (scanpipe.pipes.rootfs.RootFs method)
get_latest_failed_run() (scanpipe.models.Project method)
get_latest_output() (scanpipe.models.Project method)
get_layer_tag() (in module scanpipe.pipes.docker)
get_max_workers() (in module scanpipe.pipes.scancode)
get_next_run() (scanpipe.models.Project method)
get_output_file_path() (scanpipe.models.Project method)
get_package_archive_input() (scanpipe.pipelines.scan_package.ScanPackage method)
get_raw_url() (scanpipe.models.CodebaseResource method)
get_resource_info() (in module scanpipe.pipes.scancode)
get_resource_with_md5() (in module scanpipe.pipes.rootfs)
get_resources() (in module scanpipe.pipes.rootfs)
(scanpipe.pipes.rootfs.RootFs method)
get_root_content() (scanpipe.models.Project static method)
get_scan_json_inputs() (scanpipe.pipelines.load_inventory.LoadInventory method)
get_steps() (scanpipe.pipelines.Pipeline class method)
get_tree() (in module scanpipe.pipes.codebase)
get_type_display() (scanpipe.models.CodebaseResource method)
get_virtual_codebase() (in module scanpipe.pipes.scancode)
H
has_hash_diff() (in module scanpipe.pipes.rootfs)
holders (scanpipe.models.CodebaseResource attribute)
homepage_url (scanpipe.models.DiscoveredPackage attribute)
I
id (scanpipe.models.CodebaseResource attribute)
(scanpipe.models.DiscoveredPackage attribute)
inject_licenses_policy() (scanpipe.models.CodebaseResource method)
input_files (scanpipe.models.Project property)
input_path (scanpipe.models.Project property)
input_root (scanpipe.models.Project property)
input_sources (scanpipe.models.Project attribute)
input_sources_list (scanpipe.models.Project property)
inputs() (scanpipe.models.Project method)
inputs_with_source (scanpipe.models.Project property)
is_archive (scanpipe.models.CodebaseResource attribute)
is_archived (scanpipe.models.Project attribute)
is_binary (scanpipe.models.CodebaseResource attribute)
is_dir (scanpipe.models.CodebaseResource property)
is_file (scanpipe.models.CodebaseResource property)
is_key_file (scanpipe.models.CodebaseResource attribute)
is_media (scanpipe.models.CodebaseResource attribute)
is_symlink (scanpipe.models.CodebaseResource property)
is_text (scanpipe.models.CodebaseResource attribute)
K
keywords (scanpipe.models.DiscoveredPackage attribute)
L
last_modified_date (scanpipe.models.DiscoveredPackage attribute)
license_expression (scanpipe.models.DiscoveredPackage attribute)
license_expressions (scanpipe.models.CodebaseResource attribute)
licenses (scanpipe.models.CodebaseResource attribute)
LoadInventory (class in scanpipe.pipelines.load_inventory)
location (scanpipe.models.CodebaseResource property)
location_path (scanpipe.models.CodebaseResource property)
log (scanpipe.models.Run attribute)
log() (scanpipe.pipelines.Pipeline method)
logger (in module scanpipe.pipes.scancode)
M
make_codebase_resource() (in module scanpipe.pipes)
make_pipeline_instance() (scanpipe.models.Run method)
make_results_summary() (in module scanpipe.pipes.scancode)
make_summary_from_scan_results() (scanpipe.pipelines.scan_package.ScanPackage method)
manifest_path (scanpipe.models.DiscoveredPackage attribute)
match_not_analyzed() (in module scanpipe.pipes.rootfs)
match_not_analyzed_to_application_packages() (scanpipe.pipelines.root_filesystems.RootFS method)
match_not_analyzed_to_system_packages() (scanpipe.pipelines.root_filesystems.RootFS method)
md5 (scanpipe.models.CodebaseResource attribute)
(scanpipe.models.DiscoveredPackage attribute)
message (scanpipe.models.ProjectError attribute)
mime_type (scanpipe.models.CodebaseResource attribute)
MISSING (scanpipe.models.CodebaseResource.Compliance attribute)
missing_resources (scanpipe.models.DiscoveredPackage attribute)
model (scanpipe.models.ProjectError attribute)
modified_resources (scanpipe.models.DiscoveredPackage attribute)
module
scanpipe.pipes
scanpipe.pipes.codebase
scanpipe.pipes.compliance
scanpipe.pipes.docker
scanpipe.pipes.fetch
scanpipe.pipes.input
scanpipe.pipes.output
scanpipe.pipes.rootfs
scanpipe.pipes.scancode
scanpipe.pipes.windows
move_input_from() (scanpipe.models.Project method)
move_inputs() (in module scanpipe.pipes.input)
N
name (scanpipe.models.CodebaseResource attribute)
(scanpipe.models.DiscoveredPackage attribute)
(scanpipe.models.Project attribute)
namespace (scanpipe.models.DiscoveredPackage attribute)
normalize_path() (in module scanpipe.pipes)
notice_text (scanpipe.models.DiscoveredPackage attribute)
O
OK (scanpipe.models.CodebaseResource.Compliance attribute)
output_path (scanpipe.models.Project property)
output_root (scanpipe.models.Project property)
P
package_count (scanpipe.models.Project attribute)
package_getter() (in module scanpipe.pipes.rootfs)
(in module scanpipe.pipes.windows)
package_uid (scanpipe.models.DiscoveredPackage attribute)
path (scanpipe.models.CodebaseResource attribute)
Pipeline (class in scanpipe.pipelines)
pipeline_class (scanpipe.models.Run property)
pipeline_name (scanpipe.models.Run attribute)
primary_language (scanpipe.models.DiscoveredPackage attribute)
profile() (scanpipe.models.Run method)
programming_language (scanpipe.models.CodebaseResource attribute)
Project (class in scanpipe.models)
project (scanpipe.models.CodebaseResource attribute)
(scanpipe.models.DiscoveredPackage attribute)
(scanpipe.models.ProjectError attribute)
(scanpipe.models.Run attribute)
project_id (scanpipe.models.CodebaseResource attribute)
(scanpipe.models.DiscoveredPackage attribute)
(scanpipe.models.ProjectError attribute)
(scanpipe.models.Run attribute)
ProjectCodebase (class in scanpipe.pipes.codebase)
ProjectError (class in scanpipe.models)
projecterrors (scanpipe.models.Project attribute)
purl (scanpipe.models.DiscoveredPackage property)
purl_fields() (scanpipe.models.DiscoveredPackage class method)
Q
qualifiers (scanpipe.models.DiscoveredPackage attribute)
queryset_to_csv_file() (in module scanpipe.pipes.output)
queryset_to_csv_stream() (in module scanpipe.pipes.output)
R
release_date (scanpipe.models.DiscoveredPackage attribute)
remove_prefix() (in module scanpipe.pipes)
reset() (scanpipe.models.Project method)
resource_count (scanpipe.models.Project attribute)
RootFS (class in scanpipe.pipelines.root_filesystems)
RootFs (class in scanpipe.pipes.rootfs)
rootfs_path (scanpipe.models.CodebaseResource attribute)
Run (class in scanpipe.models)
run_command() (in module scanpipe.pipes)
run_scancode() (in module scanpipe.pipes.scancode)
(scanpipe.pipelines.scan_package.ScanPackage method)
runs (scanpipe.models.Project attribute)
S
save() (scanpipe.models.CodebaseResource method)
(scanpipe.models.Project method)
save_errors() (scanpipe.pipelines.Pipeline method)
save_scan_file_results() (in module scanpipe.pipes.scancode)
save_scan_package_results() (in module scanpipe.pipes.scancode)
scan_file() (in module scanpipe.pipes.scancode)
scan_for_application_packages() (in module scanpipe.pipes.scancode)
(scanpipe.pipelines.root_filesystems.RootFS method)
(scanpipe.pipelines.scan_codebase.ScanCodebase method)
scan_for_files() (in module scanpipe.pipes.scancode)
(scanpipe.pipelines.root_filesystems.RootFS method)
(scanpipe.pipelines.scan_codebase.ScanCodebase method)
scan_for_package_data() (in module scanpipe.pipes.scancode)
scan_image_for_system_packages() (in module scanpipe.pipes.docker)
scan_rootfs_for_system_packages() (in module scanpipe.pipes.rootfs)
ScanCodebase (class in scanpipe.pipelines.scan_codebase)
scancodeio_version (scanpipe.models.Run attribute)
ScanPackage (class in scanpipe.pipelines.scan_package)
scanpipe.pipes
module
scanpipe.pipes.codebase
module
scanpipe.pipes.compliance
module
scanpipe.pipes.docker
module
scanpipe.pipes.fetch
module
scanpipe.pipes.input
module
scanpipe.pipes.output
module
scanpipe.pipes.rootfs
module
scanpipe.pipes.scancode
module
scanpipe.pipes.windows
module
send_project_subscriptions() (scanpipe.models.Run method)
set_codebase_resource_for_package() (in module scanpipe.pipes.scancode)
set_scancodeio_version() (scanpipe.models.Run method)
setup_work_directory() (scanpipe.models.Project method)
sha1 (scanpipe.models.CodebaseResource attribute)
(scanpipe.models.DiscoveredPackage attribute)
sha256 (scanpipe.models.CodebaseResource attribute)
sha512 (scanpipe.models.CodebaseResource attribute)
size (scanpipe.models.CodebaseResource attribute)
(scanpipe.models.DiscoveredPackage attribute)
source_packages (scanpipe.models.DiscoveredPackage attribute)
status (scanpipe.models.CodebaseResource attribute)
strip_root() (in module scanpipe.pipes)
subpath (scanpipe.models.DiscoveredPackage attribute)
SYMLINK (scanpipe.models.CodebaseResource.Type attribute)
sync_with_job() (scanpipe.models.Run method)
T
tag (scanpipe.models.CodebaseResource attribute)
tag_compliance_files() (in module scanpipe.pipes.compliance)
tag_data_files_with_no_clues() (in module scanpipe.pipes.rootfs)
(scanpipe.pipelines.docker_windows.DockerWindows method)
tag_empty_codebase_resources() (in module scanpipe.pipes.rootfs)
tag_empty_files() (scanpipe.pipelines.root_filesystems.RootFS method)
(scanpipe.pipelines.scan_codebase.ScanCodebase method)
tag_ignorable_codebase_resources() (in module scanpipe.pipes.rootfs)
tag_installed_package_files() (in module scanpipe.pipes.windows)
tag_known_software() (in module scanpipe.pipes.windows)
tag_known_software_packages() (scanpipe.pipelines.docker_windows.DockerWindows method)
tag_media_files_as_uninteresting() (in module scanpipe.pipes.rootfs)
tag_not_analyzed_codebase_resources() (in module scanpipe.pipes)
(scanpipe.pipelines.root_filesystems.RootFS method)
tag_program_files() (in module scanpipe.pipes.windows)
tag_program_files_dirs_as_packages() (scanpipe.pipelines.docker_windows.DockerWindows method)
tag_uninteresting_codebase_resources() (in module scanpipe.pipes.rootfs)
(scanpipe.pipelines.docker.Docker method)
(scanpipe.pipelines.docker_windows.DockerWindows method)
(scanpipe.pipelines.root_filesystems.RootFS method)
tag_uninteresting_windows_codebase_resources() (in module scanpipe.pipes.windows)
tag_whiteout_codebase_resources() (in module scanpipe.pipes.docker)
task_end_date (scanpipe.models.Run attribute)
task_exitcode (scanpipe.models.Run attribute)
task_id (scanpipe.models.Run attribute)
task_output (scanpipe.models.Run attribute)
task_start_date (scanpipe.models.Run attribute)
tmp_path (scanpipe.models.Project property)
to_csv() (in module scanpipe.pipes.output)
to_json() (in module scanpipe.pipes.output)
to_xlsx() (in module scanpipe.pipes.output)
traceback (scanpipe.models.ProjectError attribute)
type (scanpipe.models.CodebaseResource attribute)
(scanpipe.models.DiscoveredPackage attribute)
U
unique_license_expressions (scanpipe.models.CodebaseResource property)
update_from_data() (scanpipe.models.DiscoveredPackage method)
update_or_create_package() (in module scanpipe.pipes)
urls (scanpipe.models.CodebaseResource attribute)
uuid (scanpipe.models.DiscoveredPackage attribute)
(scanpipe.models.Project attribute)
(scanpipe.models.ProjectError attribute)
(scanpipe.models.Run attribute)
V
vcs_url (scanpipe.models.DiscoveredPackage attribute)
version (scanpipe.models.DiscoveredPackage attribute)
W
walk() (scanpipe.models.CodebaseResource method)
walk_codebase_path() (scanpipe.models.Project method)
WARNING (scanpipe.models.CodebaseResource.Compliance attribute)
webhooksubscriptions (scanpipe.models.Project attribute)
WORK_DIRECTORIES (scanpipe.models.Project attribute)
work_directory (scanpipe.models.Project attribute)
work_path (scanpipe.models.Project property)
write_input_file() (scanpipe.models.Project method)
Read the Docs
v: latest
Versions
latest
Downloads
pdf
epub
On Read the Docs
Project Home
Builds