RugbyPy

https://seanyboi.github.io/rugbypy/
Admin
RugbyPy is a Python package providing rugby data analytics for over 8000 players, 250 teams, and...
Tokens:2,129
Snippets:38
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install rugbypy

Source: https://seanyboi.github.io/rugbypy

Use pip to install the package.

```bash
pip install rugbypy
```

--------------------------------

### Console output for team stats

Source: https://seanyboi.github.io/rugbypy/team.html

Example of the console output generated when initiating a data fetch request.

```text
Fetching team stats for team_id: 93542906 on date: 20251128...
```

--------------------------------

### Fetch all venues console output

Source: https://seanyboi.github.io/rugbypy/venue.html

Displays the status message shown when initiating the fetch process.

```text
Fetching all venues...
```

--------------------------------

### fetch_all_matches()

Source: https://seanyboi.github.io/rugbypy/match.html

Fetches all match information that exists, including match_id, home_team, away_team, and date.

```APIDOC
## fetch_all_matches()

### Description
Fetches all match information that exists in the system.

### Signature
`fetch_all_matches()`

### Returns
- **match_id** (str)
- **home_team** (str)
- **away_team** (str)
- **date** (str)
```

--------------------------------

### Fetch all venues with RugbyPy

Source: https://seanyboi.github.io/rugbypy

Retrieves a collection of all available venues from the registry. Requires the rugbypy.venue module.

```python
from rugbypy.venue import *
competitions = fetch_all_venues()
competitions
```

--------------------------------

### Fetch all matches

Source: https://seanyboi.github.io/rugbypy

Retrieve a list of all recorded rugby matches.

```python
from rugbypy.match import *
matches = fetch_all_matches()
matches
```

--------------------------------

### Fetch All Teams

Source: https://seanyboi.github.io/rugbypy/team.html

Retrieves a list of all available teams.

```python
fetch_all_teams()
```

--------------------------------

### Execute fetch all venues

Source: https://seanyboi.github.io/rugbypy/venue.html

Invokes the function to retrieve the complete list of venues.

```python
fetch_all_venues()
```

--------------------------------

### Fetch all matches

Source: https://seanyboi.github.io/rugbypy/match.html

Retrieves a comprehensive list of all available match records.

```python
fetch_all_matches()
```

--------------------------------

### Fetch All Players

Source: https://seanyboi.github.io/rugbypy

Retrieves a list of all players from the registry to identify specific player IDs.

```python
from rugbypy.player import *
players = fetch_all_players()
players
```

--------------------------------

### fetch_all_venues()

Source: https://seanyboi.github.io/rugbypy/venue.html

Fetches a list of all available venues, returning their unique identifiers and names.

```APIDOC
## fetch_all_venues()

### Description
Fetches all venue information that exists in the system.

### Signature
`fetch_all_venues()`

### Returns
- **venue_id** (string) - The unique identifier for the venue.
- **venue_name** (string) - The name of the venue.
```

--------------------------------

### fetch_all_players()

Source: https://seanyboi.github.io/rugbypy

Retrieves a list of all players from the player registry.

```APIDOC
## fetch_all_players()

### Description
Fetches all players available in the registry.

### Signature
`fetch_all_players()`

### Returns
A list or dataframe of players containing player_id and name.
```

--------------------------------

### Fetch all competitions

Source: https://seanyboi.github.io/rugbypy/competition.html

Retrieves a list of all available competition records.

```python
fetch_all_competitions ()
```

```python
fetch_all_competitions()
```

--------------------------------

### Fetch Competition Data

Source: https://seanyboi.github.io/rugbypy

Retrieves a list of all competition IDs available in the registry.

```python
from rugbypy.competition import *
competitions = fetch_all_competitions()
competitions
```

--------------------------------

### Fetch all venues function definition

Source: https://seanyboi.github.io/rugbypy/venue.html

Defines the function signature for retrieving all venue data.

```python
fetch_all_venues ()
```

--------------------------------

### fetch_matches_by_date(date:str)

Source: https://seanyboi.github.io/rugbypy/match.html

Fetches all match information on a particular date in the format YYYYMMDD.

```APIDOC
## fetch_matches_by_date(date:str)

### Description
Fetches all match information for a specific date.

### Parameters
- **date** (str) - Required - The date of the matches in YYYYMMDD format.

### Returns
- **match_id** (str)
- **competition_id** (str)
- **home_team_id** (str)
- **home_team_name** (str)
- **away_team_id** (str)
- **away_team_name** (str)
```

--------------------------------

### Fetch all players

Source: https://seanyboi.github.io/rugbypy/player.html

Retrieves a list of all players available in the rugbypy manifest file.

```python
fetch_all_players()
```

--------------------------------

### Fetch matches by date

Source: https://seanyboi.github.io/rugbypy/match.html

Retrieves match information for a specific date provided in YYYYMMDD format.

```python
fetch_matches_by_date(date="20251205")
```

--------------------------------

### fetch_all_competitions

Source: https://seanyboi.github.io/rugbypy/competition.html

Fetches all available competition information including match IDs, team IDs, and dates.

```APIDOC
## fetch_all_competitions()

### Description
Fetches all competition information that exists in the system.

### Signature
`fetch_all_competitions()`

### Returns
- **match_id** (string) - Identifier for the match
- **home_team_id** (string) - Identifier for the home team
- **away_team_id** (string) - Identifier for the away team
- **date** (string) - Date of the competition
```

--------------------------------

### Fetch player ID by name

Source: https://seanyboi.github.io/rugbypy/player.html

Uses a similarity tool to find the unique ID associated with a specific player name.

```python
fetch_player_id("jac morgan")
```

--------------------------------

### Fetch match details

Source: https://seanyboi.github.io/rugbypy/match.html

Retrieves detailed data for a specific match identified by its unique match_id.

```python
fetch_match_details(match_id="35e0b16d")
```

--------------------------------

### fetch_all_players

Source: https://seanyboi.github.io/rugbypy/player.html

Fetches all players available in the rugbypy manifest file.

```APIDOC
## fetch_all_players()

### Description
Fetches all players in the rugbypy manifest file.

### Signature
`fetch_all_players()`
```

--------------------------------

### fetch_all_competitions()

Source: https://seanyboi.github.io/rugbypy

Retrieves a list of all competition IDs and names from the competition registry.

```APIDOC
## fetch_all_competitions()

### Description
Fetches all competition IDs available in the registry.

### Signature
`fetch_all_competitions()`

### Returns
A list or dataframe of competitions containing competition_id and name.
```

--------------------------------

### Fetch Team Statistics

Source: https://seanyboi.github.io/rugbypy

Retrieves statistical data for a specific team. Requires importing the team module.

```python
from rugbypy.team import *
team_stats = fetch_team_stats(team_id="93542906")
team_stats
```

```python
from rugbypy.team import *
team_stats = fetch_team_stats(team_id="93542906", date="20251213")
team_stats
```

--------------------------------

### fetch_match_details(match_id:str)

Source: https://seanyboi.github.io/rugbypy/match.html

Fetches detailed match data for a specific match_id.

```APIDOC
## fetch_match_details(match_id:str)

### Description
Fetches comprehensive match data for a given match identifier.

### Parameters
- **match_id** (str) - Required - The unique identifier for the match.
```

--------------------------------

### Fetch matches

Source: https://seanyboi.github.io/rugbypy/match.html

Retrieves match data based on a provided date string.

```python
fetch_matches(date="str")
```

--------------------------------

### fetch_all_teams

Source: https://seanyboi.github.io/rugbypy/team.html

Retrieves a list of all available teams.

```APIDOC
## fetch_all_teams()

### Description
Fetches all teams available in the system.

### Method
Function Call

### Parameters
None
```

--------------------------------

### Deprecated fetch method

Source: https://seanyboi.github.io/rugbypy

This method is deprecated as of version 3; use fetch_matches_by_date instead.

```python
matches = fetch_matches(date="20230101")
```

--------------------------------

### fetch_all_teams()

Source: https://seanyboi.github.io/rugbypy

Retrieves a list of all teams available in the rugbypy database.

```APIDOC
## fetch_all_teams()

### Description
Fetches all teams currently available within the rugbypy database registry.

### Signature
`fetch_all_teams()`

### Returns
- **DataFrame** - A table containing team IDs and team names.
```

--------------------------------

### Fetch player statistics

Source: https://seanyboi.github.io/rugbypy/player.html

Retrieves performance statistics for a player. An optional date parameter in YYYYMMDD format can be provided to filter for a specific match.

```python
fetch_player_stats(player_id="24717f78")
```

```python
fetch_player_stats(player_id="24717f78", date="20250101")
```

--------------------------------

### Fetch team statistics

Source: https://seanyboi.github.io/rugbypy/team.html

Retrieves performance data for a specific team identified by its ID on a given date.

```python
fetch_team_stats(team_id="93542906", date="20251128")
```

--------------------------------

### fetch_player_id

Source: https://seanyboi.github.io/rugbypy/player.html

Uses a similarity tool to fetch a player's unique ID based on their name.

```APIDOC
## fetch_player_id(name: str)

### Description
Uses a similarity tool to fetch a player's ID based on the provided name.

### Parameters
- **name** (str) - Required - The name of the rugby player you wish to fetch the ID for.
```

--------------------------------

### Fetch Team Statistics

Source: https://seanyboi.github.io/rugbypy/team.html

Retrieves performance statistics for a specific team. Optionally filter by a specific game date using the YYYYMMDD format.

```python
fetch_team_stats(team_id="93542906")
```

--------------------------------

### fetch_player_stats

Source: https://seanyboi.github.io/rugbypy/player.html

Fetches player statistics for a specific player, optionally filtered by a specific game date.

```APIDOC
## fetch_player_stats(player_id: str, date: Optional[str] = None)

### Description
Fetches all player stats for a particular player. If a date is provided, it returns stats only for that specific game.

### Parameters
- **player_id** (str) - Required - The player ID of the player.
- **date** (str) - Optional - The date of a particular match (YYYYMMDD) to fetch stats for.
```

--------------------------------

### fetch_team_stats

Source: https://seanyboi.github.io/rugbypy/team.html

Retrieves performance statistics for a specific team, with an optional filter for a specific game date.

```APIDOC
## fetch_team_stats(team_id: str, date: Optional[str] = None)

### Description
Fetches all team stats for a particular team. If a date is provided in YYYYMMDD format, it returns statistics for that specific game.

### Method
Function Call

### Parameters
- **team_id** (str) - Required - The unique identifier for the team.
- **date** (str) - Optional - The date of the game in YYYYMMDD format.
```
Tokens:
Raw