From 7504df16ece5e2e7f770f9c1aa0757f174d55b65 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Mon, 27 Dec 2021 13:28:35 +0100 Subject: [PATCH] DOCS: anaconda-release Signed-off-by: Jan Kowalleck --- README.md | 9 +++++-- doc/processes/release/conda-forge.md | 35 ++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 2 deletions(-) create mode 100644 doc/processes/release/conda-forge.md diff --git a/README.md b/README.md index 15057af6..050d27f8 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![shield_gh-workflow-test]][link_gh-workflow-test] [![shield_pypi-version]][link_pypi] +[![shield_conda-forge-version]][link_conda-forge] [![shield_license]][license_file] [![shield_website]][link_website] [![shield_slack]][link_slack] @@ -24,12 +25,14 @@ CycloneDX is a lightweight BOM specification that is easily created, human-reada ## Installation -Install from pypi.org as you would any other Python module: +Install [from pypi.org][link_pypi] as you would any other Python module: ```shell pip install cyclonedx-python-lib ``` +_CycloneDX-python-lib_ is also available from [conda-forge][link_conda-forge]. + ## Architecture This module break out into three key areas: @@ -244,7 +247,8 @@ See the [LICENSE][license_file] file for the full license. [contributing_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/CONTRIBUTING.md [shield_gh-workflow-test]: https://img.shields.io/github/workflow/status/CycloneDX/cyclonedx-python-lib/Python%20CI/main?logo=GitHub&logoColor=white "build" -[shield_pypi-version]: https://img.shields.io/pypi/v/cyclonedx-python-lib?logo=Python&logoColor=white&label=PyPI "PyPI" +[shield_pypi-version]: https://img.shields.io/pypi/v/cyclonedx-python-lib?logo=pypi&logoColor=white&label=PyPI "PyPI" +[shield_conda-forge-version]: https://img.shields.io/conda/vn/conda-forge/cyclonedx-python-lib?logo=anaconda&logoColor=white&label=conda-forge "conda-forge" [shield_license]: https://img.shields.io/github/license/CycloneDX/cyclonedx-python-lib "license" [shield_website]: https://img.shields.io/badge/https://-cyclonedx.org-blue.svg "homepage" [shield_slack]: https://img.shields.io/badge/slack-join-blue?logo=Slack&logoColor=white "slack join" @@ -252,6 +256,7 @@ See the [LICENSE][license_file] file for the full license. [shield_twitter-follow]: https://img.shields.io/badge/Twitter-follow-blue?logo=Twitter&logoColor=white "twitter follow" [link_gh-workflow-test]: https://github.com/CycloneDX/cyclonedx-python-lib/actions/workflows/poetry.yml?query=branch%3Amain [link_pypi]: https://pypi.org/project/cyclonedx-python-lib/ +[link_conda-forge]: https://anaconda.org/conda-forge/cyclonedx-python-lib [link_website]: https://cyclonedx.org/ [link_slack]: https://cyclonedx.org/slack/invite [link_discussion]: https://groups.io/g/CycloneDX diff --git a/doc/processes/release/conda-forge.md b/doc/processes/release/conda-forge.md new file mode 100644 index 00000000..1f8515e2 --- /dev/null +++ b/doc/processes/release/conda-forge.md @@ -0,0 +1,35 @@ +# Coda-forge releases + +Releases of +[_CycloneDX-python-lib_ for Anaconda][CDXlib-conda-forge] +are managed in a [seperate conda-forge feedstock-repository][CDXlib-conda-forge-feedstock-repo] +as [anounced][first-conda-forge-release] +by [@bollwyvl]. + +## Current build status + + + + +
All platforms: + + + +
+ +## Current release info + +| Name | Downloads | Version | Platforms | +| --- | --- | --- | --- | +| [![Conda Recipe](https://img.shields.io/badge/recipe-cyclonedx--python--lib-green.svg)](https://anaconda.org/conda-forge/cyclonedx-python-lib) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/cyclonedx-python-lib.svg)](https://anaconda.org/conda-forge/cyclonedx-python-lib) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/cyclonedx-python-lib.svg)](https://anaconda.org/conda-forge/cyclonedx-python-lib) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/cyclonedx-python-lib.svg)](https://anaconda.org/conda-forge/cyclonedx-python-lib) | + +## Licensing + +The [_CycloneDX-python-lib_ conda-forge feedstock repository][CDXlib-conda-forge-feedstock-repo] is or may be licensed under a differrent form than the _CycloneDX-python-lib_ project itself. +The License of _CycloneDX-python-lib_ stayes [as stated in it's repository][license_file]. + +[CDXlib-conda-forge]: https://anaconda.org/conda-forge/cyclonedx-python-lib +[CDXlib-conda-forge-feedstock-repo]: https://github.com/conda-forge/cyclonedx-python-lib-feedstock +[@bollwyvl]: https://github.com/bollwyvl +[first-conda-forge-release]: https://github.com/CycloneDX/cyclonedx-python-lib/issues/44#issuecomment-989912153 +[license_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/LICENSE