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, strings and comments.
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 -
6. Run a basic scan to collect symbols, strings and comments using `Pygments <https://pygments.org/>`_, and display them as YAML on the screen::
scancode --pygments-symbol-and-string tests/data/symbols_ctags/test3.cpp --yaml -
7. Run a basic scan to collect symbols and strings using `Tree-Sitter <https://tree-sitter.github.io/tree-sitter/>`_, and display them as YAML on the screen::
scancode --treesitter-symbol-and-string tests/data/symbols_ctags/test3.cpp --yaml -
Raw data
{
"_id": null,
"home_page": "https://github.com/nexB/source-inspector",
"name": "source-inspector",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "utilities",
"author": "nexB. Inc. and others",
"author_email": "info@aboutcode.org",
"download_url": "https://files.pythonhosted.org/packages/90/5b/b28d6d536a2af3df498edfe441ed8e7309b76cdf8e4023c418309b529a0d/source_inspector-0.5.1.tar.gz",
"platform": null,
"description": "source-inspector\n================================\n\nsource-inspector is a set of utilities to inspect and analyze source\ncode and collect interesting data using various tools such as code symbols, strings and comments.\nThis is also a ScanCode-toolkit plugin.\n\nHomepage: https://github.com/nexB/source-inspector\nLicense: Apache-2.0\n\n\nRequirements\n~~~~~~~~~~~~~\n\nThis utility is designed to work on Linux and POSIX OS with these utilities:\n\n- xgettext that comes with GNU gettext.\n- universal ctags, version 5.9 or higher, built with JSON support.\n\nOn Debian systems run this::\n\n sudo apt-get install universal-ctags gettext\n\nOn MacOS systems run this::\n\n brew install universal-ctags gettext\n\nTo get started:\n~~~~~~~~~~~~~~~~\n\n1. Clone this repo\n\n2. Run::\n\n ./configure --dev\n source venv/bin/activate\n\n3. Run tests with::\n\n pytest -vvs\n\n4. Run a basic scan to collect symbols and display as YAML on screen::\n\n scancode --source-symbol tests/data/symbols_ctags/test3.cpp --yaml -\n\n5. Run a basic scan to collect strings and display as YAML on screen::\n\n scancode --source-string tests/data/symbols_ctags/test3.cpp --yaml -\n\n6. Run a basic scan to collect symbols, strings and comments using `Pygments <https://pygments.org/>`_, and display them as YAML on the screen::\n\n scancode --pygments-symbol-and-string tests/data/symbols_ctags/test3.cpp --yaml -\n\n7. Run a basic scan to collect symbols and strings using `Tree-Sitter <https://tree-sitter.github.io/tree-sitter/>`_, and display them as YAML on the screen::\n\n scancode --treesitter-symbol-and-string tests/data/symbols_ctags/test3.cpp --yaml -\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "source-inspector",
"version": "0.5.1",
"project_urls": {
"Homepage": "https://github.com/nexB/source-inspector"
},
"split_keywords": [
"utilities"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f0d5df9469043638c7b87d24021ce0220e228993bc4090f91430d766e3831e13",
"md5": "4b2363683a8c6329fc4bfbb77ba29a42",
"sha256": "7663465d2da83a612e2b62d02ace125451a4f63ff3ab3259e5d2632451bc880e"
},
"downloads": -1,
"filename": "source_inspector-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b2363683a8c6329fc4bfbb77ba29a42",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 17976,
"upload_time": "2024-05-16T10:40:14",
"upload_time_iso_8601": "2024-05-16T10:40:14.367489Z",
"url": "https://files.pythonhosted.org/packages/f0/d5/df9469043638c7b87d24021ce0220e228993bc4090f91430d766e3831e13/source_inspector-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "905bb28d6d536a2af3df498edfe441ed8e7309b76cdf8e4023c418309b529a0d",
"md5": "dd00456789bbad9e29b13f1f2f565c49",
"sha256": "e169bd4da20421ff000008f8e4a06ae122674e6c879c48b925358bd4324cc05c"
},
"downloads": -1,
"filename": "source_inspector-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "dd00456789bbad9e29b13f1f2f565c49",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 450052,
"upload_time": "2024-05-16T10:40:15",
"upload_time_iso_8601": "2024-05-16T10:40:15.991199Z",
"url": "https://files.pythonhosted.org/packages/90/5b/b28d6d536a2af3df498edfe441ed8e7309b76cdf8e4023c418309b529a0d/source_inspector-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 10:40:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nexB",
"github_project": "source-inspector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "source-inspector"
}
JSON
