============================
ubuntu-cloud-image-changelog
============================
.. image:: https://img.shields.io/pypi/v/ubuntu_cloud_image_changelog.svg
:target: https://pypi.python.org/pypi/ubuntu_cloud_image_changelog
Helpful utility to generate package changelog between two cloud images
* Free software: GNU General Public License v3
Install
-------
Install from snap store
This release is also available for download and install from the snap store @ https://snapcraft.io/ubuntu-cloud-image-changelog
```
sudo snap install ubuntu-cloud-image-changelog
```
This is a strict snap as recommended for most snaps, see https://snapcraft.io/docs/snap-confinement for more details.
Install from PyPi
```
pip install ubuntu-cloud-image-changelog
```
Usage
-----
```
ubuntu-cloud-image-changelog generate --from-manifest manifest1.manifest --to-manifest manifest2.manifest --from-series focal --to-series focal
```
If Packages in manifest are known to have been installed from this PPA then you can pass one of more PPAs to ubuntu-cloud-image-changelog for the changelog for those packages to be included in the output.
```
--ppa
```
Expected format is '%LAUNCHPAD_USERNAME%/%PPA_NAME%' eg. philroche/cloud-init
```
--highlight-cves
```
Highlight the CVEs referenced in each individual changelog entry
```
--output-json changelog.json
```
Output changelog to local `changelog.json` file
```
--output-json-pretty
```
Pretty print JSON output with 4 character indentation. `--output-json` must also be used for this to take affect.
TODO
----
* There are opportunities to improve performance by parallelizing the source package changelog queries and parsing.
* Refactor the generate function as it is way too long and complex.
* Add tests for the generate function.
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.15.0 (2024-01-23)
-------------------
* Improve changelog parsing to work with fips version strings
0.14.0 (2023-07-04)
-------------------
* Migrated to pydantic 2.0
* This is not a backwards compatible change and requires pydanitc 2.0 or later.
* See https://docs.pydantic.dev/latest/migration/ for migration guide used.
0.13.2 (2022-11-22)
-------------------
* Improved support for JSON output
* Added new `generate` and `schema` commands
* `schema` command generates a JSON schema for the given changelog model used in JSON output
0.12.2 (2022-11-15)
-------------------
* Added support for JSON output
* Added support for including CVE details in the JSON and text output
0.8.1 (2020-11-11)
------------------
* Improve handling of changelog parsing if from version or to version not found
0.8.0 (2020-11-09)
------------------
* handle package version that do not exactly conform to debian package version
shim-signed is a special package as it appends the version of the
binary shim from Microsoft. This full version will not appear in
the manifest so we can safely remove anything after the binary shim version.
Example version: 1.37~18.04.6+15+1533136590.3beb971-0ubuntu1
0.7.3 (2020-11-09)
------------------
* package versions in a changelog may or may not include the epoch
0.7.2 (2020-11-09)
------------------
* use consistent ubuntu-cloud-image-changelog entry point
0.7 (2020-11-09)
------------------
* Remove dependency on dpkg-parsechangelog utility.
Use python-debian to parse changelogs instead
0.6 (2020-11-09)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/CanonicalLtd/ubuntu-cloud-image-changelog",
"name": "ubuntu-cloud-image-changelog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "ubuntu_cloud_image_changelog",
"author": "Philip Roche",
"author_email": "phil.roche@canonical.com",
"download_url": "https://files.pythonhosted.org/packages/fe/09/5ca01a03c51c951459ce1cfc19da46ca97fdc40ec84fa6cf40d5354290b9/ubuntu-cloud-image-changelog-0.15.3.tar.gz",
"platform": null,
"description": "============================\nubuntu-cloud-image-changelog\n============================\n\n\n.. image:: https://img.shields.io/pypi/v/ubuntu_cloud_image_changelog.svg\n :target: https://pypi.python.org/pypi/ubuntu_cloud_image_changelog\n\nHelpful utility to generate package changelog between two cloud images\n\n* Free software: GNU General Public License v3\n\nInstall\n-------\n\nInstall from snap store\n\nThis release is also available for download and install from the snap store @ https://snapcraft.io/ubuntu-cloud-image-changelog\n\n```\nsudo snap install ubuntu-cloud-image-changelog\n```\n\nThis is a strict snap as recommended for most snaps, see https://snapcraft.io/docs/snap-confinement for more details.\n\n\nInstall from PyPi\n\n```\npip install ubuntu-cloud-image-changelog\n```\n\nUsage\n-----\n\n```\nubuntu-cloud-image-changelog generate --from-manifest manifest1.manifest --to-manifest manifest2.manifest --from-series focal --to-series focal\n```\n\nIf Packages in manifest are known to have been installed from this PPA then you can pass one of more PPAs to ubuntu-cloud-image-changelog for the changelog for those packages to be included in the output.\n\n```\n--ppa\n```\n\nExpected format is '%LAUNCHPAD_USERNAME%/%PPA_NAME%' eg. philroche/cloud-init\n\n```\n--highlight-cves\n```\n\nHighlight the CVEs referenced in each individual changelog entry\n\n```\n--output-json changelog.json\n```\n\nOutput changelog to local `changelog.json` file\n\n```\n--output-json-pretty\n```\n\nPretty print JSON output with 4 character indentation. `--output-json` must also be used for this to take affect.\n\n\nTODO\n----\n\n* There are opportunities to improve performance by parallelizing the source package changelog queries and parsing.\n* Refactor the generate function as it is way too long and complex.\n* Add tests for the generate function.\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.15.0 (2024-01-23)\n-------------------\n\n* Improve changelog parsing to work with fips version strings\n\n0.14.0 (2023-07-04)\n-------------------\n\n* Migrated to pydantic 2.0\n * This is not a backwards compatible change and requires pydanitc 2.0 or later.\n * See https://docs.pydantic.dev/latest/migration/ for migration guide used.\n\n0.13.2 (2022-11-22)\n-------------------\n\n* Improved support for JSON output\n* Added new `generate` and `schema` commands\n * `schema` command generates a JSON schema for the given changelog model used in JSON output\n\n0.12.2 (2022-11-15)\n-------------------\n\n* Added support for JSON output\n* Added support for including CVE details in the JSON and text output\n\n0.8.1 (2020-11-11)\n------------------\n\n* Improve handling of changelog parsing if from version or to version not found\n\n0.8.0 (2020-11-09)\n------------------\n\n* handle package version that do not exactly conform to debian package version\n shim-signed is a special package as it appends the version of the\n binary shim from Microsoft. This full version will not appear in\n the manifest so we can safely remove anything after the binary shim version.\n\n Example version: 1.37~18.04.6+15+1533136590.3beb971-0ubuntu1\n\n\n0.7.3 (2020-11-09)\n------------------\n\n* package versions in a changelog may or may not include the epoch\n\n0.7.2 (2020-11-09)\n------------------\n\n* use consistent ubuntu-cloud-image-changelog entry point\n\n0.7 (2020-11-09)\n------------------\n\n* Remove dependency on dpkg-parsechangelog utility.\n Use python-debian to parse changelogs instead\n\n0.6 (2020-11-09)\n------------------\n\n* First release on PyPI.\n\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "Helpful utility to generate package changelog between two cloud images",
"version": "0.15.3",
"project_urls": {
"Homepage": "https://github.com/CanonicalLtd/ubuntu-cloud-image-changelog"
},
"split_keywords": [
"ubuntu_cloud_image_changelog"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8bd64fa1630650661b8943d5587b3f8fb2f85be4ec8ca0fa1cd931453536befd",
"md5": "aefd409fa56cd27b67c86b841055a5e2",
"sha256": "ac8c8a7c99d750a3ca0357860db916915e0df683950ac3623668b004c9c481de"
},
"downloads": -1,
"filename": "ubuntu_cloud_image_changelog-0.15.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "aefd409fa56cd27b67c86b841055a5e2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.5",
"size": 15868,
"upload_time": "2024-11-08T15:16:50",
"upload_time_iso_8601": "2024-11-08T15:16:50.968566Z",
"url": "https://files.pythonhosted.org/packages/8b/d6/4fa1630650661b8943d5587b3f8fb2f85be4ec8ca0fa1cd931453536befd/ubuntu_cloud_image_changelog-0.15.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe095ca01a03c51c951459ce1cfc19da46ca97fdc40ec84fa6cf40d5354290b9",
"md5": "ee4c0f086eddd089a5df4c624350e889",
"sha256": "beabf230ff1f303f5efddc82b5dc82e831c974b7c60012e96a7e7303970d224f"
},
"downloads": -1,
"filename": "ubuntu-cloud-image-changelog-0.15.3.tar.gz",
"has_sig": false,
"md5_digest": "ee4c0f086eddd089a5df4c624350e889",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 21080,
"upload_time": "2024-11-08T15:16:52",
"upload_time_iso_8601": "2024-11-08T15:16:52.210599Z",
"url": "https://files.pythonhosted.org/packages/fe/09/5ca01a03c51c951459ce1cfc19da46ca97fdc40ec84fa6cf40d5354290b9/ubuntu-cloud-image-changelog-0.15.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-08 15:16:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CanonicalLtd",
"github_project": "ubuntu-cloud-image-changelog",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ubuntu-cloud-image-changelog"
}
JSON
