=======================
aboutcode.federatedcode
=======================
|license| |build| |release|
.. |license| image:: https://img.shields.io/badge/License-Apache--2.0-blue.svg?style=for-the-badge
:target: https://opensource.org/licenses/Apache-2.0
.. |build| image:: https://img.shields.io/github/actions/workflow/status/aboutcode-org/federatedcode/pypi-release-aboutcode-federatedcode.yml?style=for-the-badge&logo=github
.. |release| image:: https://img.shields.io/pypi/v/aboutcode.federatedcode?style=for-the-badge&logo=pypi&color=%23a569bd
:target: https://pypi.org/project/aboutcode.federatedcode/
:alt: PyPI - Version
This is a CLI and library of FederatedCode client utilities for fetching and subscribing to package metadata, and utilities for managing activity streams.
Installation
============
To install the FederatedCode client, use the following command:
.. code-block:: bash
pip install aboutcode.federatedcode
CLI Usage
=========
Use the ``federatedcode`` CLI to discover and fetch scans using the PURL:
.. code-block:: bash
# Display the general help for federatedcode
federatedcode --help
# Display help for a specific command
federatedcode [command] --help
Example
-------
Discover a PURL in the FederatedCode AP Server:
.. code-block:: bash
❯ federatedcode discover pkg:npm/%40angular/animation
http://<Your-FederatedCode-Host>/purls/@pkg:npm/%2540angular/animation
Library Usage
=============
Use the ``client`` module to fetch scan results, subscribe to packages, or discover packages
in the AP server.
.. code-block:: python
from aboutcode.federatedcode import client
Use the ``contrib`` module to get the Django mixin and various utilities to manage activity streams.
.. code-block:: python
from aboutcode.federatedcode.contrib import django
License
=======
Copyright (c) nexB Inc. and others. All rights reserved.
SPDX-License-Identifier: Apache-2.0
See https://aboutcode.org for more information about AboutCode OSS projects.
.. code-block:: none
You may not use this software except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Raw data
{
"_id": null,
"home_page": null,
"name": "aboutcode.federatedcode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "purl, Package-URL, open source, package, sca, scan, activitypub, dependencies",
"author": null,
"author_email": "\"AboutCode, nexB Inc. and others\" <info@aboutcode.org>",
"download_url": "https://files.pythonhosted.org/packages/10/a6/09092d5b958d5ba4ea80c5188c375d94930a0f0eda9766b514e4f7c36259/aboutcode_federatedcode-0.1.0.tar.gz",
"platform": null,
"description": "=======================\naboutcode.federatedcode\n=======================\n\n|license| |build| |release|\n\n.. |license| image:: https://img.shields.io/badge/License-Apache--2.0-blue.svg?style=for-the-badge\n :target: https://opensource.org/licenses/Apache-2.0\n\n.. |build| image:: https://img.shields.io/github/actions/workflow/status/aboutcode-org/federatedcode/pypi-release-aboutcode-federatedcode.yml?style=for-the-badge&logo=github\n\n.. |release| image:: https://img.shields.io/pypi/v/aboutcode.federatedcode?style=for-the-badge&logo=pypi&color=%23a569bd\n :target: https://pypi.org/project/aboutcode.federatedcode/\n :alt: PyPI - Version\n\n\nThis is a CLI and library of FederatedCode client utilities for fetching and subscribing to package metadata, and utilities for managing activity streams.\n\nInstallation\n============\n\nTo install the FederatedCode client, use the following command:\n\n.. code-block:: bash\n\n pip install aboutcode.federatedcode\n\n\nCLI Usage\n=========\n\nUse the ``federatedcode`` CLI to discover and fetch scans using the PURL:\n\n.. code-block:: bash\n\n # Display the general help for federatedcode\n federatedcode --help\n\n # Display help for a specific command\n federatedcode [command] --help\n\nExample\n-------\n\nDiscover a PURL in the FederatedCode AP Server:\n\n.. code-block:: bash\n\n \u276f federatedcode discover pkg:npm/%40angular/animation\n http://<Your-FederatedCode-Host>/purls/@pkg:npm/%2540angular/animation\n\n\nLibrary Usage\n=============\n\nUse the ``client`` module to fetch scan results, subscribe to packages, or discover packages\nin the AP server.\n\n.. code-block:: python\n\n from aboutcode.federatedcode import client\n\nUse the ``contrib`` module to get the Django mixin and various utilities to manage activity streams.\n\n.. code-block:: python\n\n from aboutcode.federatedcode.contrib import django\n\nLicense\n=======\n\nCopyright (c) nexB Inc. and others. All rights reserved.\n\nSPDX-License-Identifier: Apache-2.0\n\nSee https://aboutcode.org for more information about AboutCode OSS projects.\n\n.. code-block:: none\n\n You may not use this software except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n",
"bugtrack_url": null,
"license": null,
"summary": "A library for FederatedCode client",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/aboutcode-org/federatedcode"
},
"split_keywords": [
"purl",
" package-url",
" open source",
" package",
" sca",
" scan",
" activitypub",
" dependencies"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "566883b9ad8e401bdcafdd8a46d8d334f61eacfd6f6887cb3d0808532d713de5",
"md5": "810f3377e19628acb667792a0b997eef",
"sha256": "71bf9c9b5db0b19ea2ce88d02d868fcbfb56861865e1ea46b942a2f834aca552"
},
"downloads": -1,
"filename": "aboutcode_federatedcode-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "810f3377e19628acb667792a0b997eef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13844,
"upload_time": "2024-12-13T10:52:12",
"upload_time_iso_8601": "2024-12-13T10:52:12.250107Z",
"url": "https://files.pythonhosted.org/packages/56/68/83b9ad8e401bdcafdd8a46d8d334f61eacfd6f6887cb3d0808532d713de5/aboutcode_federatedcode-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "10a609092d5b958d5ba4ea80c5188c375d94930a0f0eda9766b514e4f7c36259",
"md5": "0e818c53be0fccbecc11b2fd6fed36a1",
"sha256": "4b8022287e2fab3f2cce413fb4b4985ab6388bba6221f82fd197961a1792ac88"
},
"downloads": -1,
"filename": "aboutcode_federatedcode-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0e818c53be0fccbecc11b2fd6fed36a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8053,
"upload_time": "2024-12-13T10:52:14",
"upload_time_iso_8601": "2024-12-13T10:52:14.749869Z",
"url": "https://files.pythonhosted.org/packages/10/a6/09092d5b958d5ba4ea80c5188c375d94930a0f0eda9766b514e4f7c36259/aboutcode_federatedcode-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 10:52:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aboutcode-org",
"github_project": "federatedcode",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aboutcode.hashid",
"specs": [
[
"==",
"0.2.0"
]
]
},
{
"name": "aboutcode.pipeline",
"specs": [
[
"==",
"0.2.0"
]
]
},
{
"name": "alabaster",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "annotated-types",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "anyio",
"specs": [
[
"==",
"4.7.0"
]
]
},
{
"name": "asgiref",
"specs": [
[
"==",
"3.8.1"
]
]
},
{
"name": "attrs",
"specs": [
[
"==",
"24.2.0"
]
]
},
{
"name": "babel",
"specs": [
[
"==",
"2.16.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.8.30"
]
]
},
{
"name": "cffi",
"specs": [
[
"==",
"1.17.1"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.4.0"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "cryptography",
"specs": [
[
"==",
"44.0.0"
]
]
},
{
"name": "Django",
"specs": [
[
"==",
"5.1.2"
]
]
},
{
"name": "django-environ",
"specs": [
[
"==",
"0.11.2"
]
]
},
{
"name": "django-ninja",
"specs": [
[
"==",
"1.3.0"
]
]
},
{
"name": "django-oauth-toolkit",
"specs": [
[
"==",
"3.0.1"
]
]
},
{
"name": "djangorestframework",
"specs": [
[
"==",
"3.15.2"
]
]
},
{
"name": "doc8",
"specs": [
[
"==",
"1.1.2"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.21.2"
]
]
},
{
"name": "exceptiongroup",
"specs": [
[
"==",
"1.2.2"
]
]
},
{
"name": "gitdb",
"specs": [
[
"==",
"4.0.11"
]
]
},
{
"name": "GitPython",
"specs": [
[
"==",
"3.1.43"
]
]
},
{
"name": "gunicorn",
"specs": [
[
"==",
"23.0.0"
]
]
},
{
"name": "h11",
"specs": [
[
"==",
"0.14.0"
]
]
},
{
"name": "http-message-signatures",
"specs": [
[
"==",
"0.5.0"
]
]
},
{
"name": "http_sfv",
"specs": [
[
"==",
"0.9.9"
]
]
},
{
"name": "httpcore",
"specs": [
[
"==",
"1.0.7"
]
]
},
{
"name": "httpx",
"specs": [
[
"==",
"0.28.1"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.10"
]
]
},
{
"name": "imagesize",
"specs": [
[
"==",
"1.4.1"
]
]
},
{
"name": "iniconfig",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "Jinja2",
"specs": [
[
"==",
"3.1.4"
]
]
},
{
"name": "jsonpointer",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "jwcrypto",
"specs": [
[
"==",
"1.5.6"
]
]
},
{
"name": "MarkupSafe",
"specs": [
[
"==",
"3.0.2"
]
]
},
{
"name": "oauthlib",
"specs": [
[
"==",
"3.2.2"
]
]
},
{
"name": "packageurl-python",
"specs": [
[
"==",
"0.16.0"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.2"
]
]
},
{
"name": "pbr",
"specs": [
[
"==",
"6.1.0"
]
]
},
{
"name": "pillow",
"specs": [
[
"==",
"11.0.0"
]
]
},
{
"name": "pluggy",
"specs": [
[
"==",
"1.5.0"
]
]
},
{
"name": "pprintpp",
"specs": [
[
"==",
"0.4.0"
]
]
},
{
"name": "psycopg2-binary",
"specs": [
[
"==",
"2.9.10"
]
]
},
{
"name": "pycparser",
"specs": [
[
"==",
"2.22"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"2.10.3"
]
]
},
{
"name": "pydantic_core",
"specs": [
[
"==",
"2.27.1"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.18.0"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"8.3.4"
]
]
},
{
"name": "pytest-django",
"specs": [
[
"==",
"4.9.0"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"6.0.2"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "restructuredtext-lint",
"specs": [
[
"==",
"1.4.0"
]
]
},
{
"name": "saneyaml",
"specs": [
[
"==",
"0.6.1"
]
]
},
{
"name": "smmap",
"specs": [
[
"==",
"5.0.1"
]
]
},
{
"name": "sniffio",
"specs": [
[
"==",
"1.3.1"
]
]
},
{
"name": "snowballstemmer",
"specs": [
[
"==",
"2.2.0"
]
]
},
{
"name": "Sphinx",
"specs": [
[
"==",
"8.1.3"
]
]
},
{
"name": "sphinx-autobuild",
"specs": [
[
"==",
"2024.10.3"
]
]
},
{
"name": "sphinx-copybutton",
"specs": [
[
"==",
"0.5.2"
]
]
},
{
"name": "sphinx-jsonschema",
"specs": [
[
"==",
"1.19.1"
]
]
},
{
"name": "sphinx-rtd-dark-mode",
"specs": [
[
"==",
"1.3.0"
]
]
},
{
"name": "sphinx-rtd-theme",
"specs": [
[
"==",
"3.0.2"
]
]
},
{
"name": "sphinx_reredirects",
"specs": [
[
"==",
"0.1.5"
]
]
},
{
"name": "sphinxcontrib-applehelp",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "sphinxcontrib-devhelp",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "sphinxcontrib-django",
"specs": [
[
"==",
"2.5"
]
]
},
{
"name": "sphinxcontrib-htmlhelp",
"specs": [
[
"==",
"2.1.0"
]
]
},
{
"name": "sphinxcontrib-jquery",
"specs": [
[
"==",
"4.1"
]
]
},
{
"name": "sphinxcontrib-jsmath",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "sphinxcontrib-qthelp",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "sphinxcontrib-serializinghtml",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "sqlparse",
"specs": [
[
"==",
"0.5.3"
]
]
},
{
"name": "starlette",
"specs": [
[
"==",
"0.41.3"
]
]
},
{
"name": "stevedore",
"specs": [
[
"==",
"5.4.0"
]
]
},
{
"name": "tomli",
"specs": [
[
"==",
"2.2.1"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.12.2"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.3"
]
]
},
{
"name": "uvicorn",
"specs": [
[
"==",
"0.32.1"
]
]
},
{
"name": "watchfiles",
"specs": [
[
"==",
"1.0.3"
]
]
},
{
"name": "websockets",
"specs": [
[
"==",
"14.1"
]
]
}
],
"lcname": "aboutcode.federatedcode"
}
