Skip to main content

Asynchronous Python client for NYT games.

Project description

Python: NYT Games

GitHub Release Python Versions Project Stage Project Maintenance License

Build Status Code Coverage

Asynchronous Python client for NYT Games.

About

This package allows you to fetch data from NYT Games.

Installation

pip install nyt_games

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

  • Python 3.11+
  • Poetry
  • NodeJS 12+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest

Authors & contributors

The content is by Joost Lekkerkerker.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2024 Joost Lekkerkerker

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nyt_games-0.4.4.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

nyt_games-0.4.4-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file nyt_games-0.4.4.tar.gz.

File metadata

  • Download URL: nyt_games-0.4.4.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for nyt_games-0.4.4.tar.gz
Algorithm Hash digest
SHA256 23cbf2cba167e3ee521ba788d7ce3e3f1485d148dd7bdff55eb6e47cc9d859d5
MD5 02960d7530d6ae39e590b85a20b47546
BLAKE2b-256 5bbe0af0a3a58ef0dabd71dd8a6c760dd8a39774ac820e76754e0300436efe4e

See more details on using hashes here.

File details

Details for the file nyt_games-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: nyt_games-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for nyt_games-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 09cfb12566bc4cb42005f96093c96a219651e592e532ab35ae1ce1f0dc4611f4
MD5 4edf8d3b0d707feecc187da425ac06b0
BLAKE2b-256 14fe4b337fc3f6d59c5e8f34b52c1567ac8922c63e70b41f85bbd770eda24f46

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page