This package is maintained with git-buildpackage(1). It follows DEP-14 for
branch naming (e.g. using debian/master for the current version in Debian
unstable due Debian Python team policy).

It uses pristine-tar(1) to store enough information in git to generate bit
identical tarballs when building the package without having downloaded an
upstream tarball first.

When working with patches it is recommended to use "gbp pq import" to import
the patches, modify the source and then use "gbp pq export --commit" to commit
the modifications.

The changelog is generated using "gbp dch" so if you submit any changes don't
bother to add changelog entries but rather provide a nice git commit message
that can then end up in the changelog.

It is recommended to build the package with pbuilder using:

    gbp buildpackage --git-pbuilder

For information on how to set up a pbuilder environment see the git-pbuilder(1)
manpage. In short:

    DIST=sid git-pbuilder create
    gbp clone https://salsa.debian.org/python-team/packages/python-inline-snapshot.git
    cd python-inline-snapshot
    gbp buildpackage --git-pbuilder


Potential privacy breach issues
-------------------------------
Lintian is complaining about the potential privacy issues:

W: python-inline-snapshot-doc: privacy-breach-generic [<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>] (https://fonts.gstatic.com) [usr/share/doc/python-inline-snapshot-doc/html/404.html]
W: python-inline-snapshot-doc: privacy-breach-generic [<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>] (https://fonts.gstatic.com) [usr/share/doc/python-inline-snapshot-doc/html/categories.html]
W: python-inline-snapshot-doc: privacy-breach-generic [<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>] (https://fonts.gstatic.com) [usr/share/doc/python-inline-snapshot-doc/html/cmp_snapshot.html]
W: python-inline-snapshot-doc: privacy-breach-generic ... use "--tag-display-limit 0" to see all (or pipe to a file/program)

The linking to external source is created by 'mkdocs', which can't be solved
within this package.

 -- Kathara Sasikumar <katharasasikumar007@gmail.com>  Fri, 09 Aug 2024 21:36:00 +0530


Using python3-inline-snapshot in Build-Depends
----------------------------------------------
The build of the documenation is using markdown-exec to execute code from the
used examples. The examples on docs/pytest.md use a pytest plugin
(--inline-snapshot) at build time. While writing this we are unable to provide
this plugin or better the availability of this plugin from the source of the
package and the build of the examples are failing similar like this:

...
␛[1;34m> pytest test_something.py --inline-snapshot=report
␛[0m␛[31mERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: unrecognized arguments: --inline-snapshot=report
  inifile: None
  rootdir: /tmp/tmp.QobpsX9YBi
␛[0m
...

Using a build dependency on the binary package python3-inline-snapshot, that is
build from the source package previously, is soving this issue at the moment.
If some can provde a solution we can inject the needed plugin at build time we
can drop this extra build dependency.


Required additional package for building -doc package
-----------------------------------------------------
Upstream is using the cz binary from commitzen within a markdown-exec call in
docs/changelog.md.
Right now this isn't packaged in Debian and we use a patch to remove this part
from the source code.

The upstream project can be found here:

https://github.com/commitizen-tools/commitizen

 -- Carsten Schoenert <c.schoenert@t-online.de>  Wed, 19 Mar 2025 18:19:00 +0200
