pfr-player-data 1.0.0

package/README.md

@@ -0,0 +1,65 @@
+# pfr-player-data
+
+Fetch NFL player data from [Pro Football Reference](https://www.pro-football-reference.com/) as structured JSON. This package scrapes a player’s PFR page and returns all available stats and info in a single JSON object.
+
+## Installation
+
+```bash
+npm install pfr-player-data
+```
+
+## Usage
+
+```javascript
+const { getPlayerData } = require('pfr-player-data');
+
+// By player URL (e.g. https://www.pro-football-reference.com/players/B/BradTo00.htm)
+const data = await getPlayerData('https://www.pro-football-reference.com/players/B/BradTo00.htm');
+
+// Or by player identifier (e.g. PFR URL slug: BradTo00)
+const data = await getPlayerData('BradTo00');
+```
+
+## API
+
+### `getPlayerData(input: string): Promise<Object>`
+
+- **`input`** — Either a full Pro Football Reference player URL or the player’s PFR identifier (e.g. `BradTo00`).
+- **Returns** — A Promise that resolves to a JSON object with all available player data from the page.
+
+## Example output
+
+The returned object includes (when present on the page):
+
+- **Bio** — Name, position, team(s), birth date, college, draft info, etc.
+- **Career stats** — Passing, rushing, receiving, defense, kicking, etc., by season and/or career totals.
+- **Game logs** — Per-game stats when available.
+- **Awards & honors** — Pro Bowls, All-Pro, other recognitions.
+- **Other tables** — Any additional tables on the player’s page (e.g. splits, advanced metrics).
+
+Structure is normalized to a consistent JSON shape so you can use it in apps, scripts, or other services without parsing HTML.
+
+## Example
+
+```javascript
+const { getPlayerData } = require('pfr-player-data');
+
+async function main() {
+  const player = await getPlayerData('BradTo00');
+  console.log(player.bio?.name);      // e.g. "Tom Brady"
+  console.log(player.careerStats);    // season-by-season and career totals
+  console.log(player.gameLogs);      // array of game log entries
+}
+
+main().catch(console.error);
+```
+
+## Notes
+
+- **Pro Football Reference**: This package is not affiliated with Sports Reference LLC or Pro Football Reference. Data is scraped from their public site.
+- **Rate limiting**: Be respectful with request frequency (e.g. add delays or caching) to avoid overloading their servers.
+- **Terms of use**: Check [Pro Football Reference’s terms of use](https://www.sports-reference.com/termsofuse.html) before heavy or commercial use.
+
+## License
+
+ISC

package/index.js

@@ -0,0 +1,5 @@
+export function hello() {
+  return "hello world";
+}
+
+module.exports = { hello };

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "pfr-player-data",
+  "version": "1.0.0",
+  "description": "Fetch NFL player data from Pro Football Reference as JSON. Scrapes a player's PFR page and returns all available stats and info.",
+  "main": "index.js",
+  "files": [
+  "dist",
+  "index.js"
+],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": ["nfl", "pro-football-reference", "pfr", "scraper", "player-stats", "football", "sports-reference"],
+  "author": "",
+  "license": "ISC"
+}