Metadata-Version: 2.1
Name: scancode-toolkit-mini
Version: 21.3.31
Summary: ScanCode is a tool to scan code for license, copyright, package and their documented dependencies and other interesting facts. scancode-toolkit-mini is a special build that does not come with pre-built binary dependencies by default. These are instead installed separately or with the extra_requires scancode-toolkit-mini[full]
Home-page: https://github.com/nexB/scancode-toolkit
Author: ScanCode
Author-email: info@aboutcode.org
License: Apache-2.0 AND CC-BY-4.0 AND LicenseRef-scancode-other-permissive AND LicenseRef-scancode-other-copyleft
Description: ================
        ScanCode toolkit
        ================
        
        A typical software project often reuses hundreds of third-party packages.
        License and origin information is not always easy to find and not normalized:
        ScanCode discovers and normalizes this data for you.
        
        Read more about ScanCode here: `scancode-toolkit.readthedocs.io <https://scancode-toolkit.readthedocs.io/en/latest/>`_.
        
        Why use ScanCode?
        =================
        
        - As a **standalone command-line tool**, ScanCode is **easy to install**, run,
          and embed in your CI/CD processing pipeline.
          It runs on **Windows, macOS, and Linux**.
        
        - ScanCode is **used by several projects and organizations** such as
          the `Eclipse Foundation <https://www.eclipse.org>`_,
          `OpenEmbedded.org <https://www.openembedded.org>`_,
          the `FSFE <https://www.fsfe.org>`_,
          the `FSF <https://www.fsf.org>`_,
          `OSS Review Toolkit <http://oss-review-toolkit.org>`_, 
          `ClearlyDefined.io <https://clearlydefined.io/>`_,
          `RedHat Fabric8 analytics <https://github.com/fabric8-analytics>`_,
          and many more.
        
        - ScanCode detects licenses, copyrights, package manifests, direct
          dependencies, and more both in **source code** and **binary** files.
        
        - ScanCode provides the **most accurate license detection engine** and does a
          full comparison (also known as diff or red line comparison) between a database
          of license texts and your code instead of relying only on approximate regex
          patterns or probabilistic search, edit distance or machine learning.
        
        - Written in Python, ScanCode is **easy to extend with plugins** to contribute
          new and improved scanners, data summarization, package manifest parsers, and
          new outputs.
        
        - You can save your scan results as **JSON, HTML, CSV or SPDX**. And you can use the
          companion `ScanCode workbench GUI app <https://github.com/nexB/scancode-workbench>`_
          to review and display scan results, statistics and graphics.
        
        - You can also organize and run ScanCode server-side with the
          companion `ScanCode.io web app <https://github.com/nexB/scancodeio>`_
          to organize and store multiple scan projects including scripting scanning piplines.
        
        
        - ScanCode is **actively maintained**, has a **growing users and contributors
          community**.
        
        - ScanCode is heavily **tested** with an automated test suite of over **20,000 tests**.
        
        - ScanCode has an extensive and growing documentation.
        
        See our `roadmap <https://scancode-toolkit.readthedocs.io/en/latest/contribute/roadmap.html>`_
        for upcoming features.
        
        
        Build and tests status
        ======================
        
        +-------+--------------+-----------------+--------------+
        |Branch | **Coverage** | **Linux/macOS** | **Windows**  |
        +=======+==============+=================+==============+
        |Master | |master-cov| | |master-posix|  | |master-win| |
        +-------+--------------+-----------------+--------------+
        |Develop| |devel-cov|  | |devel-posix|   | |devel-win|  |
        +-------+--------------+-----------------+--------------+
        
        Documentation Build
        -------------------
        
        +--------+--------------+
        |Version | **RTD Build**|
        +========+==============+
        | Latest | |docs-rtd|   |
        +--------+--------------+
        
        
        Documentation
        =============
        
        The ScanCode documentation is hosted at `scancode-toolkit.readthedocs.io <https://scancode-toolkit.readthedocs.io/en/latest/>`_.
        
        If you are new to Scancode, start `here <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/newcomer.html>`_.
        
        Other Important Documentation Pages:
        
        - A `synopsis <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_ 
          of ScanCode command line options.
        
        - Tutorials on:
        
          - `How to run a scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
          - `How to visualize scan results <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_visualize_scan_results.html>`_
        
        - An exhaustive list of `all available options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_
        
        - Documentation on `Contributing to Code Development <https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html>`_
        
        - Documentation on `Plugin Architecture <https://scancode-toolkit.readthedocs.io/en/latest/plugins/plugin_arch.html>`_
        
        - `FAQ <https://scancode-toolkit.readthedocs.io/en/latest/misc/faq.html>`_
        
        See also https://aboutcode.org for related companion projects and tools.
        
        
        Installation
        ============
        
        Before installing ScanCode make sure that you have installed the prerequisites
        properly. This means installing Python (Python 3.6+ is required).
        See `prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_
        for detailed information on the support platforms and Python versions.
        
        There are a few common ways to `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
        
        - `*Recommended* installation as an application: Download a release archive, extract and run.
          <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-as-an-application-downloading-releases>`_
        
        - `Development installation from source code using a git clone
          <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-from-source-code-git-clone>`_
        
        - `Development installation as a library with "pip install scancode-toolkit"
          <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#pip-install>`_
        
        - `Run in a Docker container with a git clone and "docker run"
          <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-via-docker>`_
        
        
        Quick Start
        ===========
        
        Note the `commands variation <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#commands-variation>`_
        across installation methods and platforms.
        
        You can run an example scan printed on screen as JSON::
        
            ./scancode -clip --json-pp - samples
        
        Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
        tutorial to perform a basic scan on the ``samples`` directory distributed by
        default with Scancode.
        
        See more command examples::
        
            ./scancode --examples
        
        See `How to select what will be detected in a scan
        <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_set_what_will_be_detected_in_a_scan.html>`_
        and `How to specify the output format <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_format_scan_output.html>`_
        for more information.
        
        You can also refer to the `command line options synopsis
        <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_
        and an exhaustive list of `all available command line options
        <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_.
        
        
        Archive extraction
        ==================
        
        By default ScanCode does not extract files from tarballs, zip files, and
        other archives as part of the scan. The archives that exist in a codebase
        must be extracted before running a scan: `extractcode` is a bundled utility
        behaving as a mostly-universal archive extractor. For example, this command will
        recursively extract the mytar.tar.bz2 tarball in the mytar.tar.bz2-extract
        directory::
        
            ./extractcode mytar.tar.bz2
        
        See `all extractcode options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html#all-extractcode-options>`_
        and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_extract_archives.html>`_ for details.
        
        
        Support
        =======
        
        If you have a problem, a suggestion or found a bug, please enter a ticket at:
        https://github.com/nexB/scancode-toolkit/issues
        
        For discussions and chats, we have:
        
        * an official Gitter channel for `web-based chats
          <https://gitter.im/aboutcode-org/discuss>`_.
          Gitter is also accessible via an `IRC bridge <https://irc.gitter.im/>`_.
          There are other AboutCode project-specific channels available there too.
        
        * an official `#aboutcode` IRC channel on freenode (server chat.freenode.net).
          This channel receives build and commit notifications and can be noisy.
          You can use your favorite IRC client or use the `web chat 
          <https://webchat.freenode.net/>`_.
        
        
        Source code and downloads
        =========================
        
        * https://github.com/nexB/scancode-toolkit/releases
        * https://github.com/nexB/scancode-toolkit.git
        * https://pypi.org/project/scancode-toolkit/
        * https://github.com/nexB/scancode-thirdparty-src.git
        
        
        License
        =======
        
        * Apache-2.0 as the overall license
        * CC-BY-4.0 for reference datasets (initially was in the Public Domain).
        * Multiple other secondary permissive or copyleft licenses (LGPL, MIT,
          BSD, GPL 2/3, etc.) for third-party components.
        
        
        See the NOTICE file and the .ABOUT files that document the origin and license of
        the third-party code used in ScanCode for more details.
        
        
        .. |master-cov| image:: https://codecov.io/gh/nexB/scancode-toolkit/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/nexB/scancode-toolkit/branch/master
            :alt: Master branch test coverage (Linux)
        .. |devel-cov| image:: https://codecov.io/gh/nexB/scancode-toolkit/branch/develop/graph/badge.svg
            :target: https://codecov.io/gh/nexB/scancode-toolkit/branch/develop
            :alt: Develop branch test coverage (Linux)
        
        .. |master-posix| image:: https://api.travis-ci.org/nexB/scancode-toolkit.png?branch=master
            :target: https://travis-ci.org/nexB/scancode-toolkit
            :alt: Linux Master branch tests status
        .. |devel-posix| image:: https://api.travis-ci.org/nexB/scancode-toolkit.png?branch=develop
            :target: https://travis-ci.org/nexB/scancode-toolkit
            :alt: Linux Develop branch tests status
        
        .. |master-win| image:: https://ci.appveyor.com/api/projects/status/4webymu0l2ip8utr/branch/master?png=true
            :target: https://ci.appveyor.com/project/nexB/scancode-toolkit
            :alt: Windows Master branch tests status
        .. |devel-win| image:: https://ci.appveyor.com/api/projects/status/4webymu0l2ip8utr/branch/develop?png=true
            :target: https://ci.appveyor.com/project/nexB/scancode-toolkit
            :alt: Windows Develop branch tests status
        
        .. |docs-rtd| image:: https://readthedocs.org/projects/scancode-toolkit/badge/?version=latest
            :target: https://scancode-toolkit.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
Keywords: open source,scan,license,package,dependency,copyright,filetype,author,extract,licensing
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Requires-Python: <4,>=3.6.*
Provides-Extra: full
Provides-Extra: packages
Provides-Extra: dev
