File: developer.rst

package info (click to toggle)
python-pysam 0.10.0%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 14,196 kB
  • ctags: 10,087
  • sloc: ansic: 79,627; python: 8,569; sh: 282; makefile: 215; perl: 41
file content (62 lines) | stat: -rw-r--r-- 1,196 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
=================
Developer's guide
=================

Code organization
=================

The top level directory is organized in the following 
directories:

:file:`pysam`
   Code specific to pysam

:file:`doc`
   The documentation. To build the latest documention type::

       make -C doc html

:file:`tests`
   Code and data for testing

:file:`htslib`
   Source code from htslib_ shipped with pysam. See
   :file:`setup.py` about importing.

:file:`samtools`
   Source code from :term:`csamtools` shipped with pysam. See
   :file:`setup.py` about importing.


Importing new versions of htslib and samtools
=============================================

See instructions in :file:`setup.py` to import the latest
version of htslib_ and samtools_.

Unit testing
============

Unit tests are in the :file:`tests` directory. To run all unit tests,
run::

   nosetests -s -v tests

Note to use the ``-s/--nocapture`` option to prevent nosetests from
captpuring standard output.

Contributors
============

Please see github for a list of all contributors:

https://github.com/pysam-developers/pysam/graphs/contributors

Many thanks to all contributors for helping in making pysam
useful.