Metadata-Version: 2.1
Name: fasta-reader
Version: 1.0.0
Summary: FASTA file reader
Home-page: https://github.com/EBI-Metagenomics/fasta-reader-py
Author: Danilo Horta
Author-email: horta@ebi.ac.uk
Maintainer: Danilo Horta
Maintainer-email: horta@ebi.ac.uk
License: MIT
Download-URL: https://github.com/EBI-Metagenomics/fasta-reader-py
Description: # fasta-reader-py
        
        FASTA file reader/writer.
        
        ## Examples
        
        Open a file and loop over its contents.
        
        ```python
        from fasta_reader import read_fasta
        
        for item in read_fasta("fasta_reader/test/correct1.faa"):
          print(item)
        # FASTAItem(defline='ID1', sequence='GAGUUA')
        # FASTAItem(defline='ID2', sequence='CAUAACAAATT')
        # FASTAItem(defline='ID3', sequence='AAGAA')
        # FASTAItem(defline='ID4', sequence='AAGAA')
        ```
        
        Open a compressed file and show the first item.
        
        ```python
        from fasta_reader import read_fasta
        
        with read_fasta("fasta_reader/test/protein.faa.gz") as file:
            item = file.read_item()
            print(item.defline, item.sequence[:10] + "...")
        # P01013 GENE X PROTEIN (OVALBUMIN-RELATED) QIKDLLVSSS...
        ```
        
        Write to `output.faa.gz`.
        
        ```python
        from fasta_reader import write_fasta
        
        with write_fasta("output.faa.gz") as file:
            file.write_item("id1 gene x protein", "AGUTAGA")
            file.write_item("id2 gene x protein", "TUUA")
        ```
        
        ## Install
        
        ```bash
        pip install fasta-reader
        ```
        
        ## Author
        
        * [Danilo Horta](https://github.com/horta)
        
        ## License
        
        This project is licensed under the [MIT License](https://raw.githubusercontent.com/EBI-Metagenomics/fasta-reader-py/master/LICENSE.md).
        
Keywords: fasta,reader
Platform: Windows
Platform: MacOS
Platform: Linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
