https://github.com/jelmer/debmutate

Manipulate Debian packages while preserving formatting
https://github.com/jelmer/debmutate

debian

Last synced: 10 days ago
JSON representation

Manipulate Debian packages while preserving formatting

• Host: GitHub
• URL: https://github.com/jelmer/debmutate
• Owner: jelmer
• License: gpl-2.0
• Created: 2020-07-06T23:27:15.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-21T14:03:19.000Z (3 months ago)
• Last Synced: 2024-10-11T13:37:02.004Z (26 days ago)
• Topics: debian
• Language: Python
• Homepage:
• Size: 727 KB
• Stars: 2
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
Debmutate is a set of Python modules for manipulating the control files of

Debian packages, with the ability to preserve the existing formatting of

the control files.

It's built on top of the excellent

[python-debian](https://salsa.debian.org/python-debian-team/python-debian)

library, and was originally extracted from

[lintian-brush](https://salsa.debian.org/jelmer/lintian-brush).

To modify one of the control files, use one of the context managers to edit the file.

For example, for debian/control:

```python

from debmutate.control import ControlEditor

with ControlEditor(path='debian/control') as control:

    print(control.source['Maintainer'])

    control.source['Maintainer'] = "Jelmer Vernooij "

```

Or for debian/changelog:

```python

from debmutate.changelog import ChangelogEditor

with ChangelogEditor(path='debian/changelog') as editor:

   editor.add_entry(['Some entry'])

```

Once you leave the context manager, the changes will be written to disk if

there were any. If the editor is unable to preserve the formatting of the

control file, it will raise a FormattingUnpreservable error.

If the control file that was edited was generated from another control file

(e.g. debian/control.in), debmutate will attempt to update that file instead

and then regenerate debian/control. If it is unable to do so, it will raise

a GeneratedFile exception.

The file will be left as-is if an exception is raised, or if the .cancel()

method is called.

debmutate currently provides editors for the following control files:

 * debian/changelog

 * debian/copyright

 * debian/control

 * debian/patches/series

 * debian/tests/control

 * debian/watch

 * debian/maintscripts, debian/\*.maintscripts

 * debian/source/lintian-overrides, debian/\*.lintian-overrides

 * debian/debcargo.toml