diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index fac16a9..3d47365 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -25,7 +25,6 @@ jobs: - name: Generate index.md from README.md run: | cp README.md docs/index.md - sed -i 's|docs/guide.md|guide/|g' docs/index.md - name: Build mkdocs site run: mkdocs build diff --git a/README.md b/README.md index 95daf50..edcd62e 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,20 @@ as utilities designed to preserve data history. The package is intended for researchers, analysts, and practitioners who require convenient programmatic access to data collection utilities. +During installation, the following packages developed by EFSA are also +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 +convenience and can be imported and used directly in the code if needed: + +```python +import eppoPynder +# and/or +import pystiller +``` + ## Installation ### From PyPi @@ -36,7 +50,7 @@ from efsa_tools import * ``` Basic usage examples and full documentation are available in the package -[guide](docs/guide.md). +[guide](https://openefsa.github.io/efsa_tools/guide/). ## Authors and maintainers @@ -45,5 +59,5 @@ Basic usage examples and full documentation are available in the package ## Links -- **Homepage**: [GitHub](https://github.com/openefsa/efsa_tools). -- **Bug Tracker**: [Issues on GitHub](https://github.com/openefsa/efsa_tools/issues). +- **Source code**: [GitHub - openefsa/efsa_tools](https://github.com/openefsa/efsa_tools). +- **Bug tracker**: [Issues on GitHub](https://github.com/openefsa/efsa_tools/issues). diff --git a/docs/guide.md b/docs/guide.md index df1382b..3b88103 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -9,6 +9,20 @@ as utilities designed to preserve data history. The package is intended for researchers, analysts, and practitioners who require convenient programmatic access to data collection utilities. +During installation, the following packages developed by EFSA are also +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 +convenience and can be imported and used directly in the code if needed: + +```python +import eppoPynder +# and/or +import pystiller +``` + ## Installation ### From PyPi diff --git a/pyproject.toml b/pyproject.toml index d40afbd..c68ad68 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -19,7 +19,9 @@ license-files = ["LICENSE"] requires-python = ">=3.11" dependencies = [ "numpy>=2.0", - "pandas>=2.2" + "pandas>=2.2", + "eppoPynder>=2.0.0", + "pystiller>=1.0.0" ] [project.optional-dependencies]