Skip to content

Commit ec20447

Browse files
committed
Docs: Added new description
- Small summary of the FASTA format and FastaParser's capabilities added to README and docs index.md - Added history to setup.py's long_description parameter
1 parent bd41d14 commit ec20447

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@
1212
[![anaconda](https://anaconda.org/kronopt/fastaparser/badges/version.svg "conda package")](https://anaconda.org/Kronopt/fastaparser)
1313
[![anaconda downloads](https://img.shields.io/conda/dn/Kronopt/fastaparser "anaconda downloads")](https://anaconda.org/Kronopt/fastaparser)
1414

15-
A Python FASTA file Parser and Writer
15+
A Python FASTA file Parser and Writer.
16+
17+
The FASTA file format is a standard text-based format for representing nucleotide and aminoacid sequences
18+
(usual file extensions include: .fasta, .fna, .ffn, .faa and .frn).
19+
FastaParser is able to parse such files and extract the biological sequences within into Python objects.
20+
It can also handle and manipulate such sequences as well as write sequences to new or existing FASTA files.
1621

1722
## Installation
1823

docs/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,9 @@
1212
[![anaconda](https://anaconda.org/kronopt/fastaparser/badges/version.svg "conda package")](https://anaconda.org/Kronopt/fastaparser)
1313
[![anaconda downloads](https://img.shields.io/conda/dn/Kronopt/fastaparser "anaconda downloads")](https://anaconda.org/Kronopt/fastaparser)
1414

15-
A Python FASTA file Parser and Writer
15+
A Python FASTA file Parser and Writer.
16+
17+
The FASTA file format is a standard text-based format for representing nucleotide and aminoacid sequences
18+
(usual file extensions include: .fasta, .fna, .ffn, .faa and .frn).
19+
FastaParser is able to parse such files and extract the biological sequences within into Python objects.
20+
It can also handle and manipulate such sequences as well as write sequences to new or existing FASTA files.

setup.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
except ImportError:
1414
from distutils.core import setup
1515

16-
with open('README.md', encoding='utf-8') as readme:
17-
DESCRIPTION = readme.read()
18-
DESCRIPTION_SHORT = 'A Python FASTA file Parser and Writer'
16+
with open('README.md', encoding='utf-8') as readme, open('docs/history.md', encoding='utf-8') as history:
17+
DESCRIPTION = readme.read() + '\n#' + history.read()
18+
DESCRIPTION_SHORT = 'A Python FASTA file Parser and Writer.'
1919

2020
setup(
2121
name='fastaparser',
@@ -31,7 +31,7 @@
3131
package_dir={'fastaparser': 'fastaparser'},
3232
keywords='fasta parser',
3333
classifiers=[
34-
'Development Status :: 4 - Beta',
34+
'Development Status :: 5 - Production/Stable',
3535
'Intended Audience :: Developers',
3636
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
3737
'Natural Language :: English',

0 commit comments

Comments
 (0)