API reference

sequensign.tools.add_sig_to_record(record, sig)

Append signature to a Biopython record.

Parameters:

  • record (SeqRecord)

  • sig (str)

sequensign.tools.get_seq_from_record(record)

Get sequence from a Biopython record.

This is a key function that ensures text representation is always the same.

Parameters:

record (SeqRecord)

sequensign.tools.get_sig_from_record(record, sig_markers=None)

Get signatures from a Biopython record.

The returned signatures include the begin/end tokens. Default setting looks for PGP signatures.

Parameters:

  • record (SeqRecord)

  • sig_markers (tuple) – Text that marks the begin and the end of a signature: (“begin”, “end”).

sequensign.tools.read_text_from_file(filename)

Read text from a file.

Parameters:

filename (str)

sequensign.tools.write_seq_in_record_to_file(record, filename=None)

Write a sequence in a Biopython record into a file.

Parameters:

  • record (SeqRecord)

  • filename (str) – Default uses record.id as filestem.

sequensign.tools.write_sigs_in_record_to_file(record, filestem=None)

Write signatures in a Biopython record into a file.

Parameters:

  • record (SeqRecord)

  • filestem (str) – Default uses record.id as filestem.

sequensign.tools.write_sigs_to_file(sigs, filestem)

Write signatures into a file.

Parameters:

  • sigs (list) – List of signatures (str).

  • filestem (str) – Each signature is saved in a different file, in the filestem_1.txt pattern.

sequensign.tools.write_text_to_file(text, filename)

Write a str to a file.

Parameters:

  • text (str)

  • filename (str)