update docs/add header info

Author: geritwagner

colrev/package_manager/doc_registry_manager.py

@@ -152,6 +152,79 @@ def _write_docs_for_index(self) -> None:
             for line in new_doc:
                 file.write(line + "\n")
 
+    # pylint: disable=line-too-long
+    # flake8: noqa: E501
+    def _get_header_info(self, package: colrev.package_manager.package.Package) -> str:
+
+        # To format the table (adjust row height), the following is suggested:
+        # from bs4 import BeautifulSoup
+
+        # # Parse the generated HTML
+        # with open('output.html', 'r') as f:
+        #     soup = BeautifulSoup(f, 'html.parser')
+
+        # # Find the table and add the ID
+        # table = soup.find('table')
+        # table['id'] = 'endpoint_overview_container'
+
+        # # Write the modified HTML back to the file
+        # with open('output.html', 'w') as f:
+        #     f.write(str(soup))
+
+        header_info = f"{package.name}\n"
+        header_info += "=" * len(package.name) + "\n\n"
+        header_info += (
+            f"- Maintainer: {', '.join(x['name'] for x in package.authors)}\n"
+        )
+        header_info += f"- License: {package.license}\n\n"
+        header_info += ".. |EXPERIMENTAL| image:: https://img.shields.io/badge/status-experimental-blue\n"
+        header_info += "   :height: 14pt\n"
+        header_info += "   :target: https://colrev.readthedocs.io/en/latest/dev_docs/dev_status.html\n"
+        header_info += ".. |MATURING| image:: https://img.shields.io/badge/status-maturing-yellowgreen\n"
+        header_info += "   :height: 14pt\n"
+        header_info += "   :target: https://colrev.readthedocs.io/en/latest/dev_docs/dev_status.html\n"
+        header_info += ".. |STABLE| image:: https://img.shields.io/badge/status-stable-brightgreen\n"
+        header_info += "   :height: 14pt\n"
+        header_info += "   :target: https://colrev.readthedocs.io/en/latest/dev_docs/dev_status.html\n"
+        header_info += ".. list-table::\n"
+        header_info += "   :header-rows: 1\n"
+        header_info += "   :widths: 20 30 80\n\n"
+
+        header_info += "   * - Endpoint\n"
+        header_info += "     - Status\n"
+        header_info += "     - Add\n"
+
+        for endpoint_type in EndpointType:
+            if package.has_endpoint(endpoint_type):
+                header_info += f"   * - {endpoint_type.value}\n"
+                header_info += f"     - |{package.status.upper()}|\n"
+                if endpoint_type == EndpointType.review_type:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev init --type {package.name}\n\n"
+                elif endpoint_type == EndpointType.search_source:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev search --add {package.name}\n\n"
+                elif endpoint_type == EndpointType.prep:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev prep --add {package.name}\n\n"
+                elif endpoint_type == EndpointType.prep_man:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev prep-man --add {package.name}\n\n"
+                elif endpoint_type == EndpointType.dedupe:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev dedupe --add {package.name}\n\n"
+                elif endpoint_type == EndpointType.prescreen:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev prescreen --add {package.name}\n\n"
+                elif endpoint_type == EndpointType.pdf_get:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev pdf-get --add {package.name}\n\n"
+                elif endpoint_type == EndpointType.pdf_get_man:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev pdf-get-man --add {package.name}\n\n"
+                elif endpoint_type == EndpointType.pdf_prep:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev pdf-prep --add {package.name}\n\n"
+                elif endpoint_type == EndpointType.pdf_prep_man:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev pdf-prep-man --add {package.name}\n\n"
+                elif endpoint_type == EndpointType.screen:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev screen --add {package.name}\n\n"
+                elif endpoint_type == EndpointType.data:
+                    header_info += f"     - .. code-block:: \n\n\n         colrev data --add {package.name}\n\n"
+
+        return header_info
+
     def _import_package_docs(
         self, package: colrev.package_manager.package.Package
     ) -> str:
@@ -164,11 +237,14 @@ def _import_package_docs(
 
         output = parse_from_file(docs_link)
 
+        header_info = self._get_header_info(package)
+
         file_path = Path(f"{package.name}.rst")
         target = packages_index_path / file_path
         with open(target, "w", encoding="utf-8") as file:
             # NOTE: at this point, we may add metadata
             # (such as package status, authors, url etc.)
+            file.write(header_info)
             file.write(output)
 
         return str(file_path)

colrev/package_manager/package.py

@@ -36,6 +36,8 @@ def __init__(self, package_dir: Path) -> None:
         self.version = self.config["project"]["version"]
         self.status = self.config["tool"]["colrev"]["dev_status"]
         self.colrev_doc_link = self.config["project"]["colrev_doc_link"]
+        self.authors = self.config["project"]["authors"]
+        self.license = self.config["project"]["license"]
 
     def _load_config(self) -> dict:
         config_path = self.package_dir / "pyproject.toml"

colrev/packages/abi_inform_proquest/README.md

@@ -1,13 +1,9 @@
-# ABI/INFORM ProQuest
+## Summary
 
 ## search
 
 ### DB search
 
-```
-colrev search --add abi_inform_proquest
-```
-
 [ABI/INFORM ProQuest](https://about.proquest.com/en/products-services/abi_inform_complete/)
 
 ## Links

colrev/packages/abi_inform_proquest/pyproject.toml

@@ -2,6 +2,7 @@
 name = "colrev.abi_inform_proquest"
 description = "CoLRev package for abi_inform_proquest"
 version = "0.1.0"
+license = "MIT"
 authors = [
     { name = "Gerit Wagner", email = "gerit.wagner@uni-bamberg.de" }
 ]

colrev/packages/acm_digital_library/README.md

@@ -1,17 +1,13 @@
-# ACM Digital Library
+## Summary
 
 ## search
 
 ### DB search
 
 ```
-colrev search --add abi_inform_proquest
+colrev search --add colrev.acm_digital_library
 ```
 
-### API search
-
-TODO
-
 ## Links
 
 - [ACM Digital Library](https://dl.acm.org/)

colrev/packages/acm_digital_library/pyproject.toml

@@ -2,6 +2,7 @@
 name = "colrev.acm_digital_library"
 description = "CoLRev package for acm_digital_library"
 version = "0.1.0"
+license = "MIT"
 authors = [
     { name = "Gerit Wagner", email = "gerit.wagner@uni-bamberg.de" }
 ]

colrev/packages/add_journal_ranking/README.md

@@ -1,29 +1,27 @@
-# Add journal rankings
+## Summary
 
 ## prep
 
 **Prerequisite** Initial ranking data is extracted from ranking.csv into SQLite Database sqlite_index.db with 'colrev env -i'.
 
-**Add the endpoint**
-
-```
-colrev prep -a colrev.add_journal_ranking
-```
-
 **Description**
 
 The add_journal_ranking package allows the user to add a ranking to the records metadata for additional automated prescreen options. While iterating through the records, this class calls the get_journal_rankings method to access the sqlite_index.db to compare if a journal_name is in one or more of the saved rankings. These rankings are being saved in the records metadata.
 
 Example:
 
+```
 journal_ranking = {Senior Scholars' List of Premier Journals}, or
 journal_ranking = {not included in a ranking},
+```
 
 Should the journal be in the Beall's Predatory Journal list, then the record will be marked as "Predatory Journal: Do not include!" and be predestined to be excluded in the scope_prescreen process.
 
 Example:
 
+```
 journal_ranking = {Predatory Journal: Do not include!},
+```
 
 The journal ranking will also be used in the colrev prescreen method and allows the user to decide if the record should be marked as 'rev_prescreen_excluded' or 'rev_prescreen_included'.
 

colrev/packages/add_journal_ranking/pyproject.toml

@@ -2,8 +2,13 @@
 name = "colrev.add_journal_ranking"
 description = "CoLRev package for add_journal_ranking"
 version = "0.1.0"
+license = "MIT"
 authors = [
-    { name = "Gerit Wagner", email = "gerit.wagner@uni-bamberg.de" }
+    { name = "Gerit Wagner", email = "gerit.wagner@uni-bamberg.de" },
+    { name = "Alexa Steinheimer"},
+    { name = "Robert Ahr"},
+    { name = "Thomas Fleischmann"},
+    { name = "Anton Liam Frisch"}
 ]
 documentation = "README.md"
 colrev_doc_link = "README.md"

colrev/packages/ais_library/README.md

@@ -1,4 +1,4 @@
-# AIS electronic Library
+## Summary
 
 ## search
 

colrev/packages/ais_library/pyproject.toml

@@ -2,6 +2,7 @@
 name = "colrev.ais_library"
 description = "CoLRev package for aisel"
 version = "0.1.0"
+license = "MIT"
 authors = [
     { name = "Gerit Wagner", email = "gerit.wagner@uni-bamberg.de" }
 ]