Metadata-Version: 2.1
Name: source-inspector
Version: 0.3.0
Summary: source-inspector
Home-page: https://github.com/nexB/source-inspector
Author: nexB. Inc. and others
Author-email: info@aboutcode.org
License: Apache-2.0
Keywords: utilities
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: apache-2.0.LICENSE
License-File: NOTICE
License-File: AUTHORS.rst
License-File: CHANGELOG.rst
License-File: CODE_OF_CONDUCT.rst
Requires-Dist: scancode-toolkit
Requires-Dist: plugincode
Requires-Dist: commoncode
Requires-Dist: typecode
Provides-Extra: docs
Requires-Dist: Sphinx >=5.0.2 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme >=1.0.0 ; extra == 'docs'
Requires-Dist: sphinx-reredirects >=0.1.2 ; extra == 'docs'
Requires-Dist: doc8 >=0.11.2 ; extra == 'docs'
Requires-Dist: sphinx-autobuild ; extra == 'docs'
Requires-Dist: sphinx-rtd-dark-mode >=1.3.0 ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Provides-Extra: testing
Requires-Dist: pytest !=7.0.0,>=6 ; extra == 'testing'
Requires-Dist: pytest-xdist >=2 ; extra == 'testing'
Requires-Dist: aboutcode-toolkit >=7.0.2 ; extra == 'testing'
Requires-Dist: pycodestyle >=2.8.0 ; extra == 'testing'
Requires-Dist: twine ; extra == 'testing'
Requires-Dist: black ; extra == 'testing'
Requires-Dist: isort ; extra == 'testing'
Requires-Dist: build ; extra == 'testing'

source-inspector
================================

source-inspector is a set of utilities to inspect and analyze source
code and collect interesting data using various tools such as code symbols and strings.
This is also a ScanCode-toolkit plugin.

Homepage: https://github.com/nexB/source-inspector
License: Apache-2.0


Requirements
~~~~~~~~~~~~~

This utility is designed to work on Linux and POSIX OS with these utilities:

- xgettext that comes with GNU gettext.
- universal ctags, version 5.9 or higher, built with JSON support.

On Debian systems run this::

    sudo apt-get install universal-ctags gettext

On MacOS systems run this::

    brew install universal-ctags gettext

To get started:
~~~~~~~~~~~~~~~~

1. Clone this repo

2. Run::

    ./configure --dev
    source venv/bin/activate

3. Run tests with::

    pytest -vvs

4. Run a basic scan to collect symbols and display as YAML on screen::

    scancode --source-symbol tests/data/symbols_ctags/test3.cpp --yaml -

5. Run a basic scan to collect strings and display as YAML on screen::

    scancode --source-string tests/data/symbols_ctags/test3.cpp --yaml -
    
