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/aboutcode-org/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/aboutcode-org/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/6b/8f/e3cfe9dac8182adac1d34560a969222c2f9d529597f0af96f124ed6b9cc5/source_inspector-0.5.2.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/aboutcode-org/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.2",
"project_urls": {
"Homepage": "https://github.com/aboutcode-org/source-inspector"
},
"split_keywords": [
"utilities"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08f633c5314475512dfcab3c286b25699fd47de624d604912e2c63ae97846c61",
"md5": "69a281beb686593531027c54202dda9a",
"sha256": "a5a157d123e4ad1b91c0e996ba11264ceb84c215e98c6673427a87eb628192d2"
},
"downloads": -1,
"filename": "source_inspector-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "69a281beb686593531027c54202dda9a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18116,
"upload_time": "2024-08-13T05:12:25",
"upload_time_iso_8601": "2024-08-13T05:12:25.634958Z",
"url": "https://files.pythonhosted.org/packages/08/f6/33c5314475512dfcab3c286b25699fd47de624d604912e2c63ae97846c61/source_inspector-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b8fe3cfe9dac8182adac1d34560a969222c2f9d529597f0af96f124ed6b9cc5",
"md5": "b681f67303eb6ea31459cfe98ddc8c53",
"sha256": "0baa9f096a35e3ac02d2800fe02bf220fe6fda42d7e109cba65a927082986c0a"
},
"downloads": -1,
"filename": "source_inspector-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "b681f67303eb6ea31459cfe98ddc8c53",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 450098,
"upload_time": "2024-08-13T05:12:27",
"upload_time_iso_8601": "2024-08-13T05:12:27.125356Z",
"url": "https://files.pythonhosted.org/packages/6b/8f/e3cfe9dac8182adac1d34560a969222c2f9d529597f0af96f124ed6b9cc5/source_inspector-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-13 05:12:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aboutcode-org",
"github_project": "source-inspector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "source-inspector"
}
JSON
