Metadata-Version: 2.5
Name: gaapitchfinder
Version: 0.1.0
Summary: Load, search, analyse, and export the GAA Pitch Finder dataset.
Project-URL: Homepage, https://gaapitchfinder.com
Project-URL: Repository, https://github.com/ryanmcg2203/gaapitchfinder
Project-URL: Dataset, https://github.com/ryanmcg2203/gaapitchfinder/blob/main/gaapitchfinder_data.csv
Author: Ryan McGuinness
License: MIT License
        
        Copyright (c) 2024 Ryan McGuinness
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: gaa,gaelic-games,geospatial,pandas,pitches
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.10
Requires-Dist: pandas>=2.0
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.8; extra == 'dev'
Requires-Dist: twine>=5.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest>=8.0; extra == 'test'
Description-Content-Type: text/markdown

# gaapitchfinder

`gaapitchfinder` is a small, dependency-light Python package for loading and
working with the [GAA Pitch Finder](https://gaapitchfinder.com) open dataset.
It bundles the canonical CSV snapshot, so importing the package never makes a
network request.

## Install

```bash
pip install gaapitchfinder
```

For local development, install the test dependencies with
`pip install -e ".[test]"`.

## Examples

```python
import gaapitchfinder as gaa

pitches = gaa.load_pitches()
gaa.search_pitches("Ballymun")
gaa.filter_pitches(county="Dublin")
gaa.nearest_pitches(latitude=53.35, longitude=-6.26, limit=10)
gaa.to_geojson(pitches)
gaa.counts_by_country()
```

Every operation that loads the default snapshot accepts a DataFrame where
appropriate, and `load_pitches("my-pitches.csv")` loads an explicit CSV. Search
is case-insensitive substring matching across `Club`, `Pitch`, `County`,
`Country`, and `Province`. Filters use case-insensitive exact matching; a
`None` filter selects missing values. `nearest_pitches` returns a
`distance_km` column and uses the haversine distance on WGS84 coordinates.

## Public schema

The package preserves the canonical CSV column names:

| Column | Type | Nullable |
| --- | --- | --- |
| `File`, `Club`, `Pitch`, `Country` | string | no |
| `Code`, `Province`, `Division`, `County`, `Directions`, `Twitter`, `Wikipedia` | string | yes |
| `Latitude`, `Longitude` | number (WGS84) | no |
| `Elevation` | number (metres) | yes |
| `annual_rainfall` | number (millimetres) | yes |
| `rain_days` | number | yes |

The bundled dataset is version `2026.09.19`, generated from the 2026-09-19
source snapshot, with schema version `1.0.0`. These identifiers are available
as `gaa.DATASET_VERSION`, `gaa.DATASET_DATE`, `gaa.SCHEMA_VERSION`, and through
`gaa.dataset_metadata()`.

## Attribution and licence

The package code is MIT licensed. The bundled dataset is licensed under the
[Creative Commons Attribution 4.0 International licence (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/).
Please credit: “Club and pitch location data from GAA Pitch Finder by Ryan
McGuinness: https://gaapitchfinder.com”.

## Development

```bash
pip install -e ".[test]"
pytest
```

For the full maintainer checks:

```bash
pip install -e ".[dev]"
ruff check .
ruff format --check .
python -m build
twine check dist/*
```

Releases are published from version tags through GitHub Actions using PyPI
Trusted Publishing. See `CONTRIBUTING.md` for the release procedure.
