diff --git a/README.md b/README.md index edcd62e..62b949c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# efsa_tools +# efsa-tools [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![codecov](https://codecov.io/gh/openefsa/efsa_tools/branch/main/graph/badge.svg?token=0YQIJKISMA)](https://codecov.io/gh/openefsa/efsa_tools) ## Overview -The **efsa_tools** package brings together all the functions developed for +The **efsa-tools** package brings together all the functions developed for EFSA's ad hoc data collections, providing tools for dataset operations as well as utilities designed to preserve data history. @@ -16,21 +16,21 @@ installed: - **eppoPynder** - [Website](https://openefsa.github.io/eppoPynder/) | [PyPI](https://pypi.org/project/eppoPynder/). - **pystiller** - [Website](https://openefsa.github.io/pystiller/) | [PyPI](https://pypi.org/project/pystiller/). -These packages are not required to use **efsa_tools**, but are included for +These packages are not required to use **efsa-tools**, but are included for convenience and can be imported and used directly in the code if needed: ```python -import eppoPynder +import eppopynder # and/or import pystiller ``` ## Installation -### From PyPi +### From PyPI ``` -pip install efsa_tools +pip install efsa-tools ``` ### Development version diff --git a/docs/guide.md b/docs/guide.md index 3b88103..f4b4855 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -1,8 +1,8 @@ -# Introduction to efsa_tools +# Introduction to efsa-tools ## Overview -The **efsa_tools** package brings together all the functions developed for +The **efsa-tools** package brings together all the functions developed for EFSA's ad hoc data collections, providing tools for dataset operations as well as utilities designed to preserve data history. @@ -14,21 +14,21 @@ installed: - **eppoPynder** - [Website](https://openefsa.github.io/eppoPynder/) | [PyPI](https://pypi.org/project/eppoPynder/). - **pystiller** - [Website](https://openefsa.github.io/pystiller/) | [PyPI](https://pypi.org/project/pystiller/). -These packages are not required to use **efsa_tools**, but are included for +These packages are not required to use **efsa-tools**, but are included for convenience and can be imported and used directly in the code if needed: ```python -import eppoPynder +import eppopynder # and/or import pystiller ``` ## Installation -### From PyPi +### From PyPI ``` -pip install efsa_tools +pip install efsa-tools ``` ### Development version @@ -41,11 +41,11 @@ pip install git+https://github.com/openefsa/efsa_tools.git ## Basic usage -The main purpose of *efsa_tools* is to provide tools for managing datasets and +The main purpose of *efsa-tools* is to provide tools for managing datasets and tracking data history within the context of data collections. Below are examples demonstrating how to use the functions in this package. -First, load the *efsa_tools* package: +First, load the *efsa-tools* package: ```python from efsa_tools import * diff --git a/media/logo.png b/media/logo.png index e82fde9..76d207a 100644 Binary files a/media/logo.png and b/media/logo.png differ diff --git a/pyproject.toml b/pyproject.toml index c68ad68..7bcc510 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=61", "wheel"] build-backend = "setuptools.build_meta" [project] -name = "efsa_tools" +name = "efsa-tools" version = "1.0.0" description = "EFSA ensemble of data collections tools" readme = "README.md"