Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
8b99814
docs: add current async usage guide
Mattsface Aug 23, 2026
faf2ab4
docs: restore focused usage examples
Mattsface Aug 23, 2026
a8b38e6
docs: rebase README refactor onto 1.1 async surface
Mattsface Aug 23, 2026
6992c36
docs: restore contributor workflow after rebase
Mattsface Aug 23, 2026
0ded087
docs: restore method reference from README
Mattsface Aug 23, 2026
55ed8f9
docs: add explicit client cleanup examples
Mattsface Aug 25, 2026
23b0e55
docs: make async explicit cleanup example runnable
Mattsface Aug 25, 2026
0987030
docs: add sync explicit cleanup example
Mattsface Aug 25, 2026
a6c92ce
docs: clean up method reference formatting
Mattsface Aug 25, 2026
9b8e888
docs: make method reference easier to scan
Mattsface Aug 25, 2026
d416124
docs: add dedicated stats usage guide
Mattsface Aug 25, 2026
bafb125
docs: point stat examples to dedicated guide
Mattsface Aug 25, 2026
225f10e
docs: link method reference to stats guide
Mattsface Aug 25, 2026
77ead30
docs: link dedicated stats guide from README
Mattsface Aug 25, 2026
509567c
docs: align README with release validation
Mattsface Aug 25, 2026
7bef313
docs: avoid main()-shaped entry point in custom HTTPX client example
github-actions[bot] Aug 25, 2026
7f5b796
docs: add multiple invocation examples for custom HTTPX client section
github-actions[bot] Aug 25, 2026
779b3ac
docs: fix async endpoint coverage wording
Mattsface Aug 25, 2026
ffe4bd7
docs: remove duplicate schedule signature
Mattsface Aug 25, 2026
b8b7ebb
docs: clarify common method examples
Mattsface Aug 25, 2026
86dc00e
docs: reconcile async coverage claims and fix method signatures
github-actions[bot] Aug 25, 2026
0159a60
docs: list CI-validated Python versions
Mattsface Aug 25, 2026
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
55 changes: 52 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,60 @@ Pull requests are the best way to propose changes to the codebase. We actively w
4. Ensure the test suite passes.
5. Issue that pull request!

## Development

Install dependencies:

```bash
poetry install -E async
```

Offline tests are deterministic and should run before every pull request:

```bash
poetry run pytest \
tests/ \
--ignore=tests/external_tests
```

External tests contact the live MLB API. They require internet access and are separate from normal offline CI:

```bash
poetry run pytest \
tests/external_tests/
```

These live tests may fail because the MLB service is unavailable or because MLB changes undocumented payloads.

Full local validation:

```bash
poetry run pytest tests/
rm -rf dist
poetry build
python3 scripts/validate_release.py
poetry run twine check dist/*
```

`scripts/validate_release.py` is the same release check offline CI runs. It inspects the built wheel and source distribution, clean-installs each artifact into its own temporary virtual environment, and runs the same public-API smoke test against both installed artifacts. Every response it observes comes from injected fake HTTP clients, so it never contacts the MLB API.

Offline CI is the normal pull-request gate. External tests are available manually, on a weekly schedule, and before releases.

## Pull Request Guidelines

- Run offline tests before submitting a PR
- Use the [PR template](.github/pull_request_template.md) when creating your pull request
- Follow the branch naming convention:
- `feat/` - New features
- `fix/` - Bug fixes
- `docs/` - Documentation updates
- `refactor/` - Code improvements

## Any contributions you make will be under the MIT Software License
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's [issues](https://github.com/zero-sum-seattle/python-mlb-statsapi/issues)
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/zero-sum-seattle/python-mlb-statsapi/issues/new).

## Write bug reports with detail, background, and sample code
**Great Bug Reports** tend to have:
Expand All @@ -37,7 +86,7 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

## Use a Consistent Coding Style
* Adhere to this projects coding style
* Adhere to this project's coding style

## License
By contributing, you agree that your contributions will be licensed under its MIT License.
By contributing, you agree that your contributions will be licensed under its MIT License.
Loading
Loading