Merge branch 'main' into gh_action

Author: sbs2001

README.rst

@@ -143,14 +143,31 @@ Tests
 Data import
 -----------
 
+Many data importers use GitHub APIs. For this, first set up value of the ``GH_TOKEN`` environment variable by running :
+
+::
+
+    export GH_TOKEN=yourgithubtoken
+
+
+See `GitHub docs  <https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token>`_ for instructions on how to obtain your GitHub token.
+
+
+To run all data importers use :
 ::
 
     DJANGO_DEV=1 python manage.py import --all
 
-It is not required to run all the importers . To quickly get started with some data run :
-:: 
+To list available importers use :
+::
+
+    DJANGO_DEV=1 python manage.py import --list
+
+To run specific importers :
+::
+
+    DJANGO_DEV=1 python manage.py import rust npm 
 
-    DJANGO_DEV=1 python manage.py import rust ruby
 
 If you want to run the import periodically, you can use a systemd timer:
 
@@ -210,4 +227,4 @@ For full documentation about API endpoints.
 .. |Gitter chat| image:: https://badges.gitter.im/gitterHQ/gitter.png
    :target: https://gitter.im/aboutcode-org/vulnerablecode
 .. |PRs Welcome| image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
-   :target: http://makeapullrequest.com
+   :target: http://makeapullrequest.com

docs/how-to-guides/add_new_importer.rst

@@ -36,10 +36,13 @@ The Building Blocks A.K.A Prerequisites
         summary: str
         impacted_package_urls: Iterable[PackageURL]
         resolved_package_urls: Iterable[PackageURL] = dataclasses.field(default_factory=list)
-        reference_urls: Sequence[str] = dataclasses.field(default_factory=list)
-        reference_ids: Sequence[str] = dataclasses.field(default_factory=list)
+        vuln_references: List[Reference] = dataclasses.field(default_factory=list)
         cve_id: Optional[str] = None
 
+    class Reference:
+
+        url: str = ''
+        reference_id: str = ''
 
 Steps to build an Importer
 --------------------------