Metadata-Version: 2.1
Name: fasta-reader
Version: 2.0.1
Summary: FASTA file reader/writer.
Home-page: https://github.com/EBI-Metagenomics/fasta-reader
License: MIT
Author: Danilo Horta
Author-email: fdanilo.horta@pm.me
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: fsspec[github,http,s3,sftp] (>=2023.1.0)
Requires-Dist: more-itertools (>=9.1.0)
Requires-Dist: xopen (>=1.7.0)
Project-URL: Repository, https://github.com/EBI-Metagenomics/fasta-reader
Description-Content-Type: text/markdown

# Welcome to fasta-reader 👋

> Read and write FASTA file

### 🏠 [Homepage](https://github.com/EBI-Metagenomics/fasta-reader-py)

## ⚡️ Requirements

- Python >= 3.9

## Install

```sh
pip install fasta-reader
```

## Examples

The following example show that it can read a compressed file remotely seamlessly:

```python
from fasta_reader import read_fasta

ROOT = "https://ftp.ncbi.nlm.nih.gov/genomes/all/GCF/009/858/895"
REF = "GCF_009858895.2_ASM985889v3"
FILE = f"{ROOT}/{REF}/{REF}_genomic.fna.gz"

print("Severe acute respiratory syndrome coronavirus 2:")
for item in read_fasta(FILE):
    print(item)
```

We can also write a FASTA file in a compressed format directly:

```python
from fasta_reader import write_fasta

with write_fasta("protein.faa.gz") as file:
    file.write_item("P01013 GENE X PROTEIN", "QIKDLLVSSSTDLDT...")
```

## 👤 Author

- [Danilo Horta](https://github.com/horta)

## Show your support

Give a ⭐️ if this project helped you!

