Merge branch 'main' into 365-update-cocoapods-pypi-support

Signed-off-by: John M. Horan <[email protected]>

.github/workflows/publish-docker.yml

@@ -0,0 +1,63 @@
+name: Publish Docker image on GHCR
+# https://docs.github.com/en/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v*.*.*"
+
+# Defines two custom environment variables for the workflow.
+# These are used for the Container registry domain,
+# and a name for the Docker image that this workflow builds.
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-22.04
+
+    # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Uses the `docker/login-action` action to log in to the Container registry using
+      # the account and password that will publish the packages.
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract tags and labels that will be applied to the specified image.
+      # The `id` "meta" allows the output of this step to be referenced in a subsequent
+      # step.
+      # The `images` value provides the base name for the tags and labels.
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      # Build the image based on your repository's `Dockerfile`.
+      # If the build succeeds, it pushes the image to GitHub Packages.
+      # It uses the `context` parameter to define the build's context as the set of
+      # files located in the specified path.
+      # It uses the `tags` and `labels` parameters to tag and label the image with
+      # the output from the "meta" step.
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: |
+            ${{ steps.meta.outputs.tags }}
+            ${{ env.REGISTRY }}/nexb/purldb:latest
+          labels: ${{ steps.meta.outputs.labels }}

CHANGELOG.rst

@@ -4,6 +4,12 @@ Changelog
 Next Release
 ----------------
 
+- Improve web template for API web page https://github.com/nexB/purldb/issues/132
+- The API endpoints for ``approximate_directory_content_index``,
+  ``approximate_directory_structure_index``, ``exact_file_index``,
+  ``exact_package_archive_index``, ``cditems``, ``on_demand_queue`` have been
+  removed.
+
 
 v5.0.0
 ---------
@@ -14,7 +20,7 @@ v5.0.0
 - Support indexing of PURLs listed in https://github.com/nexB/purldb/issues/326,
   https://github.com/nexB/purldb/issues/327, https://github.com/nexB/purldb/issues/328,
   https://github.com/nexB/purldb/issues/329 and https://github.com/nexB/purldb/issues/356.
-- Support ``addon_pipelines`` for symbol and string collection in ``/api/collect`` endpoint. https://github.com/nexB/purldb/pull/393 
+- Support ``addon_pipelines`` for symbol and string collection in ``/api/collect`` endpoint. https://github.com/nexB/purldb/pull/393
 - Store ``source_symbols`` and ``source_strings`` in ``extra_data`` field. https://github.com/nexB/purldb/pull/351
 
 

README.rst

@@ -1,6 +1,6 @@
 The purldb
 ==========
-This repo consists of four main tools:
+This repo consists of these main tools:
 
 - PackageDB that is the reference model (based on ScanCode toolkit)
   that contains package data with purl (Package URLs) being a first
@@ -10,6 +10,8 @@ This repo consists of four main tools:
   matching
 - MatchCode.io that provides package matching functionalities for codebases
 - ClearCode that contains utilities to mine Clearlydefined for package data
+- purldb-toolkit CLI utility and library to use the PurlDB, its API and various
+  related libraries.
 
 These are designed to be used first for reference such that one can query for
 packages by purl and validate purl existence.
@@ -191,37 +193,3 @@ To run PurlDB and Matchcode.io with Docker:
 
   docker compose -f docker-compose.yml up -d
   docker compose -f docker-compose.matchcodeio.yml up -d
-
-Funding
--------
-
-This project was funded through the NGI Assure Fund https://nlnet.nl/assure, a
-fund established by NLnet https://nlnet.nl/ with financial support from the
-European Commission's Next Generation Internet programme, under the aegis of DG
-Communications Networks, Content and Technology under grant agreement No 957073.
-
-This project is also funded through grants from the Google Summer of Code
-program, continuing support and sponsoring from nexB Inc. and generous
-donations from multiple sponsors.
-
-
-License
--------
-
-Copyright (c) nexB Inc. and others. All rights reserved.
-
-purldb is a trademark of nexB Inc.
-
-SPDX-License-Identifier: Apache-2.0 AND CC-BY-SA-4.0
-
-purldb software is licensed under the Apache License version 2.0.
-
-purldb data is licensed collectively under CC-BY-SA-4.0.
-
-See https://www.apache.org/licenses/LICENSE-2.0 for the license text.
-
-See https://creativecommons.org/licenses/by-sa/4.0/legalcode for the license text.
-
-See https://github.com/nexB/purldb for support or download.
-
-See https://aboutcode.org for more information about nexB OSS projects.

docs/source/getting-started/contribute.rst

@@ -1,5 +1,5 @@
-Contirbute
-===========
+Contribute
+==========
 
 Documentation to support code and documentation contributions
 to purldb.

docs/source/how-to-guides/index.rst

@@ -2,13 +2,12 @@ How-To-Guides
 =============
 
 Here are the various how-to guides across various purldb projects to guide you
-thourgh specifica use cases:
-
-- Code matching with Matchcode
-- Getting symbols from a package (or a PURL)
+through specific use cases:
 
 .. toctree::
    :maxdepth: 2
 
+   installation
+   tasks
    matchcode
    tutorial_symbol_and_string_collection