Merge pull request #48 from uberfastman/release/v15.0.0

Release v15.0.0

.dockerignore

@@ -0,0 +1,25 @@
+# macOS
+**.DS_Store
+
+# JetBrains
+.idea/
+
+# Python
+**__pycache__
+**.pytest_cache
+
+# environment
+**.env*
+!**.env.template*
+.venv
+
+# auth secrets
+**private*.json
+!**private.template.json
+**token*.json
+!**token.template.json
+
+# Docker
+compose*.yaml
+.dockerignore
+docker/Dockerfile

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,25 @@
+---
+name: Bug Report
+about: 'Report any bugs, errors, problems, etc. found in YFPY. '
+title: "[Bug] Short Description of Erroneous/Problematic Behavior"
+labels: bug
+assignees: uberfastman
+
+---
+
+## Description of Issue
+Please put a longer description of the bug/issue/problem you are encountering here, as well as anything else you think might be relevant or helpful to reproduce the issue.
+
+## Additional Information as Applicable
+
+#### Yahoo Fantasy Sports League ID
+XXXXXX...
+
+#### Yahoo Fantasy Sports League Privacy
+Public/Private
+
+#### Operating System/Environment
+macOS/Windows/Linux/Docker/etc.
+
+#### Other
+Any other setup/environment/configuration information you might deem potentially relevant.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,14 @@
+---
+name: Feature Request
+about: Suggest a new idea/feature for YFPY.
+title: "[Feature Request] Short Description of New Idea/Feature"
+labels: feature
+assignees: ''
+
+---
+
+## Description
+Please describe what new idea/feature would like to see added to the YFPY package.
+
+## Use case
+Please elaborate on how your idea/feature request will provide additional value/functionality.

.gitignore

@@ -20,12 +20,12 @@ dist/
 test_output/
 
 # Environment
-*.env
+*.env*
+!.env.template
 *.venv
-!EXAMPLE.env
 .python-version
 
 # Credentials
 *private*.json
-!EXAMPLE.private.json
+!private.template.json
 *token*.json

MANIFEST.in

@@ -9,8 +9,11 @@ include requirements.txt
 include dev-requirements.txt
 
 # Include Yahoo Fantasy Sports REST API authentication resources
-include auth/EXAMPLE.private.json
-include auth/EXAMPLE.env
+include auth/private.template.json
+include auth/.env.template
+
+# Include YFPY Docker resources
+include compose.yaml
 
 # Include quickstart resources
 include quickstart/quickstart.py

README.md

@@ -91,7 +91,7 @@ In order to use YFPY with private fantasy leagues, you must set up an app on you
     * `API Permissions` (**Required**): check the `Fantasy Sports` checkbox. You can leave the `Read` option selected (appears in an accordion expansion underneath the `Fantasy Sports` checkbox once you select it).
     * Click the `Create App` button.
     * Once the app is created, it should redirect you to a page for your app, which will show both a `Client ID` and a `Client Secret`.
-    * Make a copy of [`auth/EXAMPLE.private.json`](https://github.com/uberfastman/yfpy/blob/main/auth/EXAMPLE.private.json), rename it to just `private.json`, and copy the `Client ID` and `Client Secret` values to their respective fields (make sure the strings are wrapped regular quotes (`""`), NOT formatted quotes (`“”`)). The path to this file will be needed to point YFPY to your credentials.
+    * Make a copy of [`auth/private.template.json`](https://github.com/uberfastman/yfpy/blob/main/auth/private.template.json), rename it to just `private.json`, and copy the `Client ID` and `Client Secret` values to their respective fields (make sure the strings are wrapped regular quotes (`""`), NOT formatted quotes (`“”`)). The path to this file will be needed to point YFPY to your credentials.
     * Now you should be ready to initialize the OAuth2 connection between YFPY your Yahoo account.
 
 ---
@@ -113,6 +113,34 @@ In order to use YFPY with private fantasy leagues, you must set up an app on you
   * Uncomment/comment out whichever query lines in the `RUN QUERIES` section you wish to run.
   * Uncomment/comment out whichever query lines in the `CHECK FOR MISSING DATA FIELDS` section you wish to check for any new/missing data fields returned by the Yahoo Sports Fantasy Football API.
 
+#### Docker
+
+YFPY can be used within Docker for a more seamless, platform-agnostic experience.
+
+* Build the Docker image:
+    ```shell
+    docker compose build
+    ```
+* Run the Docker container:
+    ```shell
+    docker compose up
+    ``` 
+* You can then run commands in the Docker container in two different ways:
+  * Connect to the running container and run commands from within it:
+    ```shell
+    docker exec -it yfpy-package-1 bash
+    ```
+    Then:
+    ```shell
+    python quickstart/quickstart.py
+    ```
+  * Send commands to the running container from your host machine:
+    ```shell
+    docker exec -i yfpy-package-1 bash -c "python quickstart/quickstart.py"
+    ```
+
+***NOTE***: *If you wish to actively make changes to or develop against YFPY within the Docker container, uncomment the `- .:/opt/yfpy` volume mount in [`compose.yaml`](https://github.com/uberfastman/yfpy/blob/main/compose.yaml) so that any code changes you make in YFPY are reflected inside the running container.* 
+
 ---
 
 <a name="testing"></a>
@@ -127,7 +155,7 @@ YFPY has a collection of fully functional code snippets that can be run using [p
 #### Integration
 
 * See the [`test/integration`](https://github.com/uberfastman/yfpy/blob/main/test/integration/) directory for example code snippets using pytest.
-* Before running any integration tests, make a copy of [`auth/EXAMPLE.env`](https://github.com/uberfastman/yfpy/blob/main/auth/EXAMPLE.env) in the [`auth/`](https://github.com/uberfastman/yfpy/blob/main/auth/) directory and rename it to `.env`.
+* Before running any integration tests, make a copy of [`auth/.env.template`](https://github.com/uberfastman/yfpy/blob/main/auth/.env.template) in the [`auth/`](https://github.com/uberfastman/yfpy/blob/main/auth/) directory and rename it to `.env`.
 * Copy your Yahoo `Client ID` and `Client Secret` into the environment variables in `.env` so that pytest can use them when hitting the Yahoo Fantasy Sports API.
 * If this is the first time running pytest with your Yahoo API credentials, you ***MUST*** allow interactive prompts within pytest by using the `-s` flag.
 * The fixture values in [`test/integration/conftest.py`](https://github.com/uberfastman/yfpy/blob/main/test/integration/conftest.py) are defined in [`quickstart/quickstart.py`](https://github.com/uberfastman/yfpy/blob/main/quickstart/quickstart.py), and can be changed for testing by uncommenting/commenting out the values inside each respective function.

VERSION.py

@@ -1,2 +1,2 @@
 # DO NOT EDIT - VERSIONING CONTROLLED BY GIT TAGS
-__version__ = "v13.0.0"
+__version__ = "v15.0.0"

compose.yaml

@@ -0,0 +1,21 @@
+services:
+  package:
+    build:
+      # DO NOT EDIT PYTHON VERSION BUILD ARGUMENTS - VERSIONING CONTROLLED BY GIT TAGS
+      args:
+      - PYTHON_VERSION_MAJOR=3
+      - PYTHON_VERSION_MINOR=11
+      context: .
+      dockerfile: docker/Dockerfile
+    image: ghcr.io/uberfastman/yfpy:15.0.0  # DO NOT EDIT IMAGE - VERSIONING CONTROLLED BY GIT TAGS
+    platform: linux/amd64
+    environment:
+    - RUNTIME_ENVIRONMENT=docker
+    env_file:
+    - ./auth/.env
+    ports:
+    - 5001:5000
+    volumes:
+    - /etc/localtime:/etc/localtime
+    # UNCOMMENT LOCAL CODE REPOSITORY MOUNT BELOW FOR LOCAL CHANGES TO BE REFLECTED WITHIN THE RUNNING DOCKER CONTAINER
+    #- .:/opt/yfpy

docker/Dockerfile

@@ -0,0 +1,36 @@
+ARG PYTHON_VERSION_MAJOR=$PYTHON_VERSION_MAJOR
+ARG PYTHON_VERSION_MINOR=$PYTHON_VERSION_MINOR
+
+# set base image
+FROM --platform=linux/amd64 python:${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}-slim
+
+LABEL "org.opencontainers.image.source"="https://github.com/uberfastman/yfpy"
+
+# update package index list
+RUN apt update && \
+    apt upgrade && \
+    apt install -y git
+
+# set the working directory in the container
+WORKDIR /opt/yfpy
+
+# set python environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+## copy the project root contents to the working directory
+COPY .. .
+
+# install dependencies
+RUN pip install --upgrade pip && \
+    pip install -r requirements.txt
+
+RUN chmod +x ./docker/docker-entrypoint.sh
+
+# specify docker as package runtime environment
+ENV RUNTIME_ENVIRONMENT docker
+
+ENTRYPOINT ["./docker/docker-entrypoint.sh"]
+
+# command to run on container start
+CMD tail -f /dev/null

docker/docker-entrypoint.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# startup message
+/bin/echo "YFPY is ready!"
+
+# execute CMD from Dockerfile
+exec "$@"

docs-sphinx/source/_autosummary/yfpy.models.Pick.rst

@@ -0,0 +1,29 @@
+yfpy.models.Pick
+================
+
+.. currentmodule:: yfpy.models
+
+.. autoclass:: Pick
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :special-members: __call__, __add__, __mul__
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :nosignatures:
+
+      ~Pick.clean_data_dict
+      ~Pick.from_json
+      ~Pick.serialized
+      ~Pick.subclass_dict
+      ~Pick.to_json
+
+
+
+
+
+

docs-sphinx/source/_autosummary/yfpy.models.rst

@@ -38,6 +38,7 @@
       OutcomeTotals
       Ownership
       PercentOwned
+      Pick
       Player
       PlayerAdvancedStats
       PlayerPoints

docs-sphinx/source/_autosummary/yfpy.query.YahooFantasySportsQuery.rst

@@ -71,5 +71,6 @@
    .. autosummary::
 
       ~YahooFantasySportsQuery.YFO
+      ~YahooFantasySportsQuery.runtime_environment_is_docker
 
 

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 97ec4bc4af03b9613a945ece5253f01a
+config: fae182cad2c5b57636b1822573cedae6
 tags: 645f666f9bcd5a90fca523b33c5a78b7