[](https://edwards.flinders.edu.au)
[](https://www.zenodo.org/badge/latestdoi/270903677)
[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/py-fasta-validator/)
[](https://anaconda.org/bioconda/py_fasta_validator)
# py_fasta_validator
A Python extension of the [fasta validator](https://github.com/linsalrob/fasta_validator)
This is a Python C-extension to validate a fasta file. It only checks a few things, and by default only sets its response via the return code, so you will need to check that in your Python code. See the examples provided.
The simple rules that we adhere to are:
1. Each header line starts with a `>`. The header preceedes the sequence.
2. Every other line is considered a sequence line
3. Sequence lines may not contain whitespace, numbers, or non-sequence characters. In other words, they must only contain the characters [A-Z] and [a-z]
4. Sequence lines can end with a new line or return depending on whether you have edited this file on a mac, pc, or linux machine.
5. Sequence lines can be empty.
6. The sequence identifier is the string of characters in the header line following the `>` and upto the first whitespace. Everything after the first whitespace is descriptive, and can be as long as you like
7. Each sequence identifier must be unique within the fasta file.
We will exit with the following return codes:
* `0` this is a valid fasta file
* `1` the first line does not start with a > (rule 1 violated).
* `2` there are duplicate sequence identifiers in the file (rule 7 violated)
* `4` there are characters in a sequence line other than [A-Za-z]
Other exit codes (e.g. 255, 254, etc) indicate internal errors in the program.
# Running py_fasta_validator
The installation now also includes a command line application, `py_fasta_validator` that you can run. See the Testing section below!
You can also import FastaValidator directly:
```python
import FastaValidator
return_code = FastaValidator.fasta_validator(file_name)
```
# Installation
### Everyone
_Recommended:_
Install with conda. This is the easiest way to install `py_fasta_validator` and the recommended method:
```command-line
conda install -c bioconda py_fasta_validator
```
_Alternate method:_
Install with pip:
```
pip install py-fasta-validator
```
### Advanced
#### Prerequisites
If you install using one the methods above you don't need to worry about the prerequistes, they are already included!
[fasta validator](https://github.com/linsalrob/fasta_validator) is written in ANSI C but you will also need the Python developers toolkit (e.g. python-3.x-dev installed on your machine to provide Python.h)
To clone the code from GitHub use:
```bash
git clone https://github.com/linsalrob/fasta_validator.git
cd fasta_validator
```
To build the code, use:
```bash
make
```
This should compile the source into an executable in the current working directory.
Please note, if you get an error like this:
```
gcc -Wall -o fasta_validate ./fasta_validate.c -I/usr/include/python3.8 -I/usr/include/x86_64-linux-gnu/python3.8
/usr/bin/ld: /tmp/ccgvrFaq.o: in function `python_input':
fasta_validate.c:(.text+0x481): undefined reference to `PyArg_ParseTuple'
/usr/bin/ld: fasta_validate.c:(.text+0x48c): undefined reference to `PyExc_RuntimeError'
/usr/bin/ld: fasta_validate.c:(.text+0x49b): undefined reference to `PyErr_SetString'
/usr/bin/ld: fasta_validate.c:(.text+0x4c3): undefined reference to `PyLong_FromLong'
/usr/bin/ld: /tmp/ccgvrFaq.o: in function `PyInit_fastaValidator':
fasta_validate.c:(.text+0x4f2): undefined reference to `PyModule_Create2'
collect2: error: ld returned 1 exit status
make: *** [Makefile:9: all] Error 1
```
Then we need to append the version of python to the `make` command. I am (currently) running `python3.8` and the command to compile without error is:
```
make CFLAGS=-lpython3.8
```
<small>I don't know the exact cause of this error, but `pkg-config --libs python3` is not reporting anything when it should report `-lpython3.8`</small>
To install this code as root (sudo) you can use:
```bash
make install
```
and this will copy the executable to `/usr/local/bin`.
to install it as a user, just copy the compiled binary `fasta_validate` to somewhere on your path.
# Testing
To test the code you can use the example data provided. Download the [test data set](https://github.com/linsalrob/py_fasta_validator/raw/master/test.zip) [zip file, 16.4 kb] and uncompress it.
```command-line
$ for FASTA in test/*fasta; do echo $FASTA; py_fasta_validator -f $FASTA; echo "Exit code: $?"; done
```
This will output the name of the fasta file, the output, and the exit code from the process:
```command-line
test/code.fasta
test/code.fasta has non-sequence characters in it
Exit code: 4
test/duplicates_no_spaces.fasta
test/duplicates_no_spaces.fasta has multiple sequences with the same identifier
Exit code: 2
test/duplicates_with_spaces.fasta
test/duplicates_with_spaces.fasta has multiple sequences with the same identifier
Exit code: 2
test/good.fasta
Exit code: 0
test/good_mixed.fasta
Exit code: 0
test/good_multiline.fasta
Exit code: 0
test/no_first_line.fasta
test/no_first_line.fasta does not start with a >
Exit code: 1
test/space.fasta
test/space.fasta has non-sequence characters in it
Exit code: 4
```
# Developing/Testing
Note, if you are developing and testing in a conda environment, you might run into an error like:
```
./fasta_validate: error while loading shared libraries: libpython3.11.so.1.0: cannot open shared object file: No such file or directory
```
You need to make sure that `LD_LIBRARY_PATH` is set to your `/lib/` in your conda environment.
For example:
```bash
$ ./fasta_validate
./fasta_validate: error while loading shared libraries: libpython3.11.so.1.0: cannot open shared object file: No such file or directory
$ mamba install -y python-devtools
$ which python
~/miniconda3/envs/py_fasta/bin/python
$ export LD_LIBRARY_PATH_OLD=$LD_LIBRARY_PATH # make a back up of the original LD_LIBRARY_PATH, just in case!
$ export LD_LIBRARY_PATH=$HOME/miniconda3/envs/py_fasta/lib/:$LD_LIBRARY_PATH # set the new library path
$ ./fasta_validate
./fasta_validate [-v] [fasta file]
```
Note: to make this change permanent you should set the `$LD_LIBRARY_PATH` variable (and the copy) in `etc/conda/activate.d/env_vars.sh` and `etc/conda/deactivate.d/env_vars.sh` as [described in the docs](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#macos-and-linux)
# Citation
Please cite this as
Edwards, R.A. 2019. fasta_validate: a fast and efficient fasta validator written in pure C. DOI: 10.5281/zenodo.2532044
[](https://zenodo.org/badge/latestdoi/164130774)
# What is the difference between this and [fasta_validator](https://github.com/linsalrob/fasta_validator)?
Not very much!
The original C code was written for the [Search SRA](https://searchsra.org/) project as we wanted to validate fasta files uploaded by users. That code is written in C, and does not require any additional libraries to install.
This version adds the Python hooks, and so it requires the Python development library to be installed. Therefore, we kept them as two separate projects, although you'll notice the C code is essentially the same!
# License
This software is released using the [MIT License](LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/linsalrob/py_fasta_validator",
"name": "py-fasta-validator",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "bioinformatics genome genomics fasta",
"author": "Rob Edwards",
"author_email": "raedwards@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e2/9f/d9894ba8496d039a5d8abf20d17ba680fcb57de4e2ecb3f925c958015509/py_fasta_validator-0.6.tar.gz",
"platform": "any",
"description": "[](https://edwards.flinders.edu.au)\n[](https://www.zenodo.org/badge/latestdoi/270903677)\n[](https://opensource.org/licenses/MIT)\n\n[](https://pypi.org/project/py-fasta-validator/)\n[](https://anaconda.org/bioconda/py_fasta_validator)\n\n# py_fasta_validator\n\nA Python extension of the [fasta validator](https://github.com/linsalrob/fasta_validator)\n\nThis is a Python C-extension to validate a fasta file. It only checks a few things, and by default only sets its response via the return code, so you will need to check that in your Python code. See the examples provided.\n\nThe simple rules that we adhere to are:\n\n1. Each header line starts with a `>`. The header preceedes the sequence.\n2. Every other line is considered a sequence line\n3. Sequence lines may not contain whitespace, numbers, or non-sequence characters. In other words, they must only contain the characters [A-Z] and [a-z]\n4. Sequence lines can end with a new line or return depending on whether you have edited this file on a mac, pc, or linux machine.\n5. Sequence lines can be empty.\n6. The sequence identifier is the string of characters in the header line following the `>` and upto the first whitespace. Everything after the first whitespace is descriptive, and can be as long as you like\n7. Each sequence identifier must be unique within the fasta file.\n\nWe will exit with the following return codes:\n\n* `0` this is a valid fasta file\n* `1` the first line does not start with a > (rule 1 violated).\n* `2` there are duplicate sequence identifiers in the file (rule 7 violated)\n* `4` there are characters in a sequence line other than [A-Za-z]\n\nOther exit codes (e.g. 255, 254, etc) indicate internal errors in the program.\n\n# Running py_fasta_validator\n\nThe installation now also includes a command line application, `py_fasta_validator` that you can run. See the Testing section below!\n\nYou can also import FastaValidator directly:\n\n```python\nimport FastaValidator\n\nreturn_code = FastaValidator.fasta_validator(file_name)\n```\n\n# Installation\n\n### Everyone\n\n_Recommended:_\n\nInstall with conda. This is the easiest way to install `py_fasta_validator` and the recommended method:\n\n```command-line\nconda install -c bioconda py_fasta_validator\n```\n\n_Alternate method:_\n\nInstall with pip:\n\n```\npip install py-fasta-validator\n```\n\n### Advanced\n\n#### Prerequisites\n\nIf you install using one the methods above you don't need to worry about the prerequistes, they are already included!\n\n[fasta validator](https://github.com/linsalrob/fasta_validator) is written in ANSI C but you will also need the Python developers toolkit (e.g. python-3.x-dev installed on your machine to provide Python.h)\n\n\nTo clone the code from GitHub use:\n\n```bash\ngit clone https://github.com/linsalrob/fasta_validator.git\ncd fasta_validator\n```\n\nTo build the code, use:\n\n```bash\nmake\n```\n\nThis should compile the source into an executable in the current working directory.\n\nPlease note, if you get an error like this:\n\n```\ngcc -Wall -o fasta_validate ./fasta_validate.c -I/usr/include/python3.8 -I/usr/include/x86_64-linux-gnu/python3.8\n/usr/bin/ld: /tmp/ccgvrFaq.o: in function `python_input':\nfasta_validate.c:(.text+0x481): undefined reference to `PyArg_ParseTuple'\n/usr/bin/ld: fasta_validate.c:(.text+0x48c): undefined reference to `PyExc_RuntimeError'\n/usr/bin/ld: fasta_validate.c:(.text+0x49b): undefined reference to `PyErr_SetString'\n/usr/bin/ld: fasta_validate.c:(.text+0x4c3): undefined reference to `PyLong_FromLong'\n/usr/bin/ld: /tmp/ccgvrFaq.o: in function `PyInit_fastaValidator':\nfasta_validate.c:(.text+0x4f2): undefined reference to `PyModule_Create2'\ncollect2: error: ld returned 1 exit status\nmake: *** [Makefile:9: all] Error 1\n```\n\nThen we need to append the version of python to the `make` command. I am (currently) running `python3.8` and the command to compile without error is:\n\n```\nmake CFLAGS=-lpython3.8\n```\n\n<small>I don't know the exact cause of this error, but `pkg-config --libs python3` is not reporting anything when it should report `-lpython3.8`</small>\n\nTo install this code as root (sudo) you can use:\n\n```bash\nmake install\n```\n\nand this will copy the executable to `/usr/local/bin`.\n\nto install it as a user, just copy the compiled binary `fasta_validate` to somewhere on your path.\n\n\n# Testing\n\nTo test the code you can use the example data provided. Download the [test data set](https://github.com/linsalrob/py_fasta_validator/raw/master/test.zip) [zip file, 16.4 kb] and uncompress it.\n\n```command-line\n$ for FASTA in test/*fasta; do echo $FASTA; py_fasta_validator -f $FASTA; echo \"Exit code: $?\"; done\n```\n\nThis will output the name of the fasta file, the output, and the exit code from the process:\n\n```command-line\ntest/code.fasta\ntest/code.fasta has non-sequence characters in it\nExit code: 4\ntest/duplicates_no_spaces.fasta\ntest/duplicates_no_spaces.fasta has multiple sequences with the same identifier\nExit code: 2\ntest/duplicates_with_spaces.fasta\ntest/duplicates_with_spaces.fasta has multiple sequences with the same identifier\nExit code: 2\ntest/good.fasta\nExit code: 0\ntest/good_mixed.fasta\nExit code: 0\ntest/good_multiline.fasta\nExit code: 0\ntest/no_first_line.fasta\ntest/no_first_line.fasta does not start with a >\nExit code: 1\ntest/space.fasta\ntest/space.fasta has non-sequence characters in it\nExit code: 4\n```\n\n\n# Developing/Testing\n\nNote, if you are developing and testing in a conda environment, you might run into an error like:\n\n```\n./fasta_validate: error while loading shared libraries: libpython3.11.so.1.0: cannot open shared object file: No such file or directory\n```\n\nYou need to make sure that `LD_LIBRARY_PATH` is set to your `/lib/` in your conda environment.\n\nFor example:\n\n```bash\n$ ./fasta_validate\n./fasta_validate: error while loading shared libraries: libpython3.11.so.1.0: cannot open shared object file: No such file or directory\n$ mamba install -y python-devtools\n$ which python\n~/miniconda3/envs/py_fasta/bin/python\n$ export LD_LIBRARY_PATH_OLD=$LD_LIBRARY_PATH # make a back up of the original LD_LIBRARY_PATH, just in case!\n$ export LD_LIBRARY_PATH=$HOME/miniconda3/envs/py_fasta/lib/:$LD_LIBRARY_PATH # set the new library path\n$ ./fasta_validate \n./fasta_validate [-v] [fasta file]\n```\n\nNote: to make this change permanent you should set the `$LD_LIBRARY_PATH` variable (and the copy) in `etc/conda/activate.d/env_vars.sh` and `etc/conda/deactivate.d/env_vars.sh` as [described in the docs](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#macos-and-linux)\n\n\n# Citation\n\nPlease cite this as \n\nEdwards, R.A. 2019. fasta_validate: a fast and efficient fasta validator written in pure C. DOI: 10.5281/zenodo.2532044\n[](https://zenodo.org/badge/latestdoi/164130774)\n\n# What is the difference between this and [fasta_validator](https://github.com/linsalrob/fasta_validator)?\n\nNot very much!\n\nThe original C code was written for the [Search SRA](https://searchsra.org/) project as we wanted to validate fasta files uploaded by users. That code is written in C, and does not require any additional libraries to install.\n\nThis version adds the Python hooks, and so it requires the Python development library to be installed. Therefore, we kept them as two separate projects, although you'll notice the C code is essentially the same!\n\n# License\n\nThis software is released using the [MIT License](LICENSE)\n\n\n",
"bugtrack_url": null,
"license": "The MIT License (MIT)",
"summary": "A small, lightweight, fast fasta validator written in C",
"version": "0.6",
"split_keywords": [
"bioinformatics",
"genome",
"genomics",
"fasta"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e29fd9894ba8496d039a5d8abf20d17ba680fcb57de4e2ecb3f925c958015509",
"md5": "7a48127afa9c69f6c3a12e0e93306bbf",
"sha256": "ca29c20e1be31ef190f923b62ddb7fccda8c1c3ba9cf699a6ccaccce10ea011a"
},
"downloads": -1,
"filename": "py_fasta_validator-0.6.tar.gz",
"has_sig": false,
"md5_digest": "7a48127afa9c69f6c3a12e0e93306bbf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 41969,
"upload_time": "2023-02-05T05:27:38",
"upload_time_iso_8601": "2023-02-05T05:27:38.706412Z",
"url": "https://files.pythonhosted.org/packages/e2/9f/d9894ba8496d039a5d8abf20d17ba680fcb57de4e2ecb3f925c958015509/py_fasta_validator-0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-05 05:27:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "linsalrob",
"github_project": "py_fasta_validator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "setuptools-scm",
"specs": []
}
],
"lcname": "py-fasta-validator"
}
JSON
