Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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).
14 changes: 14 additions & 0 deletions docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Loading