Skip to content

Commit

Permalink
Merge branch 'release/1.0.0'
Browse files Browse the repository at this point in the history
First working release
  • Loading branch information
sb43 committed Jul 10, 2020
2 parents a8eee68 + 007fadd commit 99ababb
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 15 deletions.
8 changes: 8 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/LICENCE
/INSTALL
/CHANGES.md
/.gitignore
/.git
/.travis.yml
/env
/dist
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## 1.0.0
* First commit
* First working release

17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ This project hosts scripts to annotate VCF files using user defined driver genes
<!-- /TOC -->

## Design
Uses [bcftools] and tabix from htslib

Uses [bcftools], [tabix] and [bgzip] in user's path , these are part of [htslib] or can be installed separately

## Tools

Expand Down Expand Up @@ -59,10 +60,6 @@ pip install annotateVcf.X.X.X-py3-none-any.whl

Release `.whl` files are generated as part of the release process and can be found on the [release page][annotateVcf-releases]

### Package Dependancies

`pip` will install the relevant dependancies, listed here for convenience, please refer requirements.txt for versions.

## Development environment

This project uses git pre-commit hooks. As these will execute on your system it
Expand Down Expand Up @@ -136,9 +133,11 @@ pip install --find-links=~/wheels annotateVcf

### Reference
<!--refs-->
[bcftools]: http://samtools.github.io/bcftools/bcftools.html
[htslib]: https://github.com/samtools/htslib
[bcftools]: https://github.com/samtools/bcftools
[tabix]: https://github.com/samtools/tabix
[VAGrENT]: https://github.com/cancerit/VAGrENT
[travis-master-badge]: https://travis-ci.org/cancerit/annotateVcf.svg?branch=master
[travis-develop-badge]: https://travis-ci.org/cancerit/annotateVcf.svg?branch=develop
[travis-master-badge]: https://travis-ci.org/cancerit/annotateVCF.svg?branch=master
[travis-develop-badge]: https://travis-ci.org/cancerit/annotateVCF.svg?branch=develop
[travis-repo]: https://travis-ci.org/cancerit/annotateVcf
[annotateVcf-releases]: https://github.com/cancerit/annotateVcf/releases
[annotateVcf-releases]: https://github.com/cancerit/annotateVCF/releases
4 changes: 0 additions & 4 deletions requirements.txt

This file was deleted.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
'python_requires': '>= 3.3',
'install_requires': ['tzlocal'],
'packages': ['annotate'],
'package_data': {'annotate':['config/*.conf','config/drvData/*']},
'package_data': {'annotate':['config/*.conf','config/*.json','config/drvData/*']},
'entry_points': {
'console_scripts': ['annotateVcf=annotate.annotate_cmd:main'],
}
Expand Down

0 comments on commit 99ababb

Please sign in to comment.