Metadata-Version: 2.4
Name: py-virion-data
Version: 0.3.0
Summary: Consistent and ergonomic methods for accessing versioned Virion data
Project-URL: Documentation, https://github.com/viralemergence/py-virion-data#readme
Project-URL: Issues, https://github.com/viralemergence/py-virion-data/issues
Project-URL: Source, https://github.com/viralemergence/py-virion-data
Author-email: collinschwantes <collin@viralemergence.org>, collin.schwantes@yale.edu, ricardorivero <rrh9619@gmail.com>, ricardo.rivero@wsu.edu
License-Expression: MIT
License-File: LICENSE.txt
Keywords: data package,viral ecology,virion,virus host interactions
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.8
Requires-Dist: fsspec
Requires-Dist: pandas
Requires-Dist: requests
Description-Content-Type: text/markdown

# py-virion-data

[![PyPI - Version](https://img.shields.io/pypi/v/py-virion-data.svg)](https://pypi.org/project/py-virion-data)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/py-virion-data.svg)](https://pypi.org/project/py-virion-data)
[![codecov](https://codecov.io/github/viralemergence/py-virion-data/graph/badge.svg?token=PNEFR3NP4T)](https://codecov.io/github/viralemergence/py-virion-data)
-----

## Table of Contents

- [Installation](#installation)
- [License](#license)

## Installation

```console
pip install py-virion-data
```

## License

`py-virion-data` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

## Package development and maintenance 

This package was developed using the [PyOpenSci package tutorial](https://www.pyopensci.org/python-package-guide/tutorials/intro.html) and follows their best practices as closely as possible. 

Therefore we use [hatch](https://hatch.pypa.io/1.16/) to build, test, and document the package.

### Versioning

major - changes to defined classes that break previous releases 
minor - changes or refactors to defined classes that add, refine or modify features without breaking functionality from previous releases. A minor release may also occur if there are significant improvements testing, documentation or other user support features. 
patch - quick fixes to correct malfunctioning code, or improvements to testing, documentation, or other user support features.  

To change the version run the following code:

```
hatch version minor
```

see [hatch versioning](https://hatch.pypa.io/1.9/version/) for more details.



### Testing

Tests are stored in the "tests" directory and test configurations can be found in the pyproject.toml file. See [Using Hatch for Developing](https://www.pyopensci.org/python-package-guide/tutorials/develop-python-package-hatch.html) for more info.

To run tests locally:
```
hatch run test:run_local
```
