Browse Source

Add README file.

snapgene-write
Damien Goutte-Gattat 2 years ago
parent
commit
a02fd398db
  1. 49
      README.md

49
README.md

@ -0,0 +1,49 @@
BinSeqs - Support for binary sequence formats in Bioython
=========================================================
BinSeqs is a Python package intended to enrich the SeqIO
framework from [Biopython](https://biopython.org/) by adding
support for some binary sequence formats.
Formats supported
-----------------
* `xdna` format, used by _DNA Strider_ and
[Serial Cloner](http://serialbasics.free.fr/Serial_Cloner.html):
reading and writing supported
* `snapgene` format, used by [SnapGene](https://www.snapgene.com/):
reading support only
Usage
-----
The BinSeqs parsers and writers are not designed to be used
independently and should instead be used through the Biopython's
SeqIO module.
Simply import the `incenp.bio.seqio` module to make the parsers
and writers available to Biopython's SeqIO:
from Bio import SeqIO
import incenp.bio.seqio
records = list(SeqIO.parse('snapgene_file.dna', 'snapgene'))
SeqIO.write(records, 'serialcloner_file.xdna', 'xdna')
Copying
-------
BinSeqs is free software and distributed under the terms of
a BSD-like license. The full license is included in the
[LICENSE.txt file](LICENSE.txt) of the source distribution.
Homepage and contact
--------------------
The latest source code is available at <git://git.incenp.org/binseqs.git>
and may also be browsed using the Gitweb interface at
<https://incenp.org/dvlpt/gitweb/?p=binseqs.git;a=summary>.
To contact the author, use the following address:
Damien Goutte-Gattat <dgouttegattat@incenp.org>
Loading…
Cancel
Save