Add goresym support

.github/workflows/docs-ci.yml

@@ -20,9 +20,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Give permission to run scripts
-        run: chmod +x ./docs/scripts/doc8_style_check.sh
-
       - name: Install Dependencies
         run:  pip install -e .[docs]
 

README.rst

@@ -1,62 +1,8 @@
-A Simple Python Project Skeleton
+Go-Inspector
 ================================
-This repo attempts to standardize the structure of the Python-based project's
-repositories using modern Python packaging and configuration techniques.
-Using this `blog post`_ as inspiration, this repository serves as the base for
-all new Python projects and is mergeable in existing repositories as well.
 
-.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/
-
-
-Usage
-=====
-
-A brand new project
--------------------
-.. code-block:: bash
-
-    git init my-new-repo
-    cd my-new-repo
-    git pull [email protected]:nexB/skeleton
-
-    # Create the new repo on GitHub, then update your remote
-    git remote set-url origin [email protected]:nexB/your-new-repo.git
-
-From here, you can make the appropriate changes to the files for your specific project.
-
-Update an existing project
----------------------------
-.. code-block:: bash
-
-    cd my-existing-project
-    git remote add skeleton [email protected]:nexB/skeleton
-    git fetch skeleton
-    git merge skeleton/main --allow-unrelated-histories
-
-This is also the workflow to use when updating the skeleton files in any given repository.
-
-More usage instructions can be found in ``docs/skeleton-usage.rst``.
-
-
-Release Notes
-=============
-
-- 2023-07-18:
-    - Add macOS-13 job in azure-pipelines.yml
-
-- 2022-03-04:
-    - Synchronize configure and configure.bat scripts for sanity
-    - Update CI operating system support with latest Azure OS images
-    - Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party dependencies
-      There are now fewer scripts. See etc/scripts/README.rst for details
-
-- 2021-09-03:
-    - ``configure`` now requires pinned dependencies via the use of ``requirements.txt`` and ``requirements-dev.txt``
-    - ``configure`` can now accept multiple options at once
-    - Add utility scripts from scancode-toolkit/etc/release/ for use in generating project files
-    - Rename virtual environment directory from ``tmp`` to ``venv``
-    - Update README.rst with instructions for generating ``requirements.txt`` and ``requirements-dev.txt``,
-      as well as collecting dependencies as wheels and generating ABOUT files for them.
-
-- 2021-05-11:
-    - Adopt new configure scripts from ScanCode TK that allows correct configuration of which Python version is used.
+- To enable the GoReSym plugin, first you need to install goresym from https://github.com/mandiant/GoReSym/releases/download/v2.6.4/GoReSym.zip
+- Unzip the GoReSym.zip, extract goresym for linux and add it in src/go_inspector/bin.
+- then change it to executable  ```chmod u+x src/go_inspector/bin/GoReSym_lin```
+- Install requirements and dependencies using ```make dev```
+- Use ```scancode --json-pp - --go-symbol <PATH> --verbose``` to get debug symbols.

azure-pipelines.yml

@@ -11,54 +11,54 @@ jobs:
       parameters:
           job_name: ubuntu20_cpython
           image_name: ubuntu-20.04
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
+          python_versions: ['3.8', '3.9', '3.10', '3.11']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ubuntu22_cpython
           image_name: ubuntu-22.04
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
+          python_versions: ['3.8', '3.9', '3.10', '3.11']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos11_cpython
-          image_name: macOS-11
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
+    # - template: etc/ci/azure-posix.yml
+    #   parameters:
+    #       job_name: macos11_cpython
+    #       image_name: macOS-11
+    #       python_versions: ['3.8', '3.9', '3.10', '3.11']
+    #       test_suites:
+    #           all: venv/bin/pytest -n 2 -vvs
 
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos12_cpython
-          image_name: macOS-12
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
+    # - template: etc/ci/azure-posix.yml
+    #   parameters:
+    #       job_name: macos12_cpython
+    #       image_name: macOS-12
+    #       python_versions: ['3.8', '3.9', '3.10', '3.11']
+    #       test_suites:
+    #           all: venv/bin/pytest -n 2 -vvs
 
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos13_cpython
-          image_name: macOS-13
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
+    # - template: etc/ci/azure-posix.yml
+    #   parameters:
+    #       job_name: macos13_cpython
+    #       image_name: macOS-13
+    #       python_versions: ['3.8', '3.9', '3.10', '3.11']
+    #       test_suites:
+    #           all: venv/bin/pytest -n 2 -vvs
 
-    - template: etc/ci/azure-win.yml
-      parameters:
-          job_name: win2019_cpython
-          image_name: windows-2019
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv\Scripts\pytest -n 2 -vvs
+    # - template: etc/ci/azure-win.yml
+    #   parameters:
+    #       job_name: win2019_cpython
+    #       image_name: windows-2019
+    #       python_versions: ['3.8', '3.9', '3.10', '3.11']
+    #       test_suites:
+    #           all: venv\Scripts\pytest -n 2 -vvs
 
-    - template: etc/ci/azure-win.yml
-      parameters:
-          job_name: win2022_cpython
-          image_name: windows-2022
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv\Scripts\pytest -n 2 -vvs
+    # - template: etc/ci/azure-win.yml
+    #   parameters:
+    #       job_name: win2022_cpython
+    #       image_name: windows-2022
+    #       python_versions: ['3.8', '3.9', '3.10', '3.11']
+    #       test_suites:
+    #           all: venv\Scripts\pytest -n 2 -vvs

docs/Makefile

@@ -5,6 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
+SPHINXAUTOBUILD = sphinx-autobuild
 SOURCEDIR     = source
 BUILDDIR      = build
 
@@ -14,6 +15,13 @@ help:
 
 .PHONY: help Makefile
 
+# Run the development server using sphinx-autobuild
+docs:
+	@echo
+	@echo "Starting up the docs server..."
+	@echo
+	$(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

docs/make.bat

@@ -7,11 +7,16 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
+if "%SPHINXAUTOBUILD%" == "" (
+	set SPHINXAUTOBUILD=sphinx-autobuild
+)
 set SOURCEDIR=source
 set BUILDDIR=build
 
 if "%1" == "" goto help
 
+if "%1" == "docs" goto docs
+
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
@@ -28,6 +33,13 @@ if errorlevel 9009 (
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
+:docs
+@echo
+@echo Starting up the docs server...
+@echo
+%SPHINXAUTOBUILD% --port 8000 --watch %SOURCEDIR% %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O%
+goto end
+
 :help
 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%