Devex Improvements (joeyagreco#120)

- Use Ruff as a formatter
- General Makefile improvements

.github/dependabot.yml

@@ -5,7 +5,7 @@
 
 version: 2
 updates:
-  - package-ecosystem: "pip" # See documentation for possible values
-    directory: "/" # Location of package manifests
+  - package-ecosystem: "pip"
+    directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "monthly"

.github/workflows/unit-tests.yml

@@ -18,20 +18,18 @@ jobs:
   build:
     name: unit tests
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10"]
 
     steps:
       - uses: actions/checkout@v3
 
-      - name: Get current required Python version
-        id: get-python-versions
-        run: |
-          MINIMUM_VERSION=$(grep -oP '__version_minimum_python__ = "\K.*(?=")' leeger/_version.py)
-          echo "CURRENT_VERSION=$MINIMUM_VERSION" >> $GITHUB_ENV
-
       - name: Set up Python
         uses: actions/setup-python@v3
         with:
-          python-version: ${{ env.CURRENT_VERSION }}
+          python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: |

Makefile

@@ -1,39 +1,32 @@
 .PHONY: deps
 deps:
-	@python3.10 -m pip install -r requirements.dev.txt
-	@python3.10 -m pip install -r requirements.txt
+	@python -m pip install -r requirements.dev.txt
+	@python -m pip install -r requirements.txt
 
 .PHONY: fmt
 fmt:
-	@black --config=pyproject.toml .
-	@autoflake --config=pyproject.toml .
-	@isort .
+	@ruff check --fix
+	@ruff format
 
 .PHONY: fmt-check
 fmt-check:
-	@black --config=pyproject.toml . --check
-	@autoflake --config=pyproject.toml . --check
-	@isort . --check-only
-
+	@ruff check
+	@ruff format --check
 
 .PHONY: test
 test:
-	@python3.10 -m pytest test/
-
-.PHONY: reqs
-reqs:
-	@pipreqs --force --mode compat
+	@python -m pytest test/
 
 .PHONY: pkg-build
 pkg-build:
 	@rm -rf build
 	@rm -rf dist
-	@python3.10 setup.py sdist bdist_wheel
+	@python setup.py sdist bdist_wheel
 
 .PHONY: pkg-test
 pkg-test:
-	@python3.10 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+	@python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 
 .PHONY: pkg-prod
 pkg-prod:
-	@python3.10 -m twine upload dist/*
+	@python -m twine upload dist/*

e2e/variables.py

@@ -17,13 +17,22 @@
 teamDominic2019 = Team(ownerId=ownerDominic.id, name="Bike Ridas")
 
 matchup1 = Matchup(
-    teamAId=teamFrankie2019.id, teamBId=teamDominic2019.id, teamAScore=101.2, teamBScore=122
+    teamAId=teamFrankie2019.id,
+    teamBId=teamDominic2019.id,
+    teamAScore=101.2,
+    teamBScore=122,
 )
 matchup2 = Matchup(
-    teamAId=teamMonika2019.id, teamBId=teamGiovanna2019.id, teamAScore=78.4, teamBScore=114.3
+    teamAId=teamMonika2019.id,
+    teamBId=teamGiovanna2019.id,
+    teamAScore=78.4,
+    teamBScore=114.3,
 )
 matchup3 = Matchup(
-    teamAId=teamJoseph2019.id, teamBId=teamVincent2019.id, teamAScore=112, teamBScore=145.3
+    teamAId=teamJoseph2019.id,
+    teamBId=teamVincent2019.id,
+    teamAScore=112,
+    teamBScore=145.3,
 )
 
 matchup4 = Matchup(
@@ -107,6 +116,13 @@
 
 LEAGUE = League(
     name="G League",
-    owners=[ownerFrankie, ownerMonika, ownerJoseph, ownerVincent, ownerGiovanna, ownerDominic],
+    owners=[
+        ownerFrankie,
+        ownerMonika,
+        ownerJoseph,
+        ownerVincent,
+        ownerGiovanna,
+        ownerDominic,
+    ],
     years=[year2019],
 )

example/league/comparingLeagueObjects.py

@@ -10,7 +10,9 @@
 
     # 2. lets compare it
     league.equals(league)  # compares models with all fields
-    league.equals(league, ignoreBaseIds=True)  # ignores the base "id" field in each object
+    league.equals(
+        league, ignoreBaseIds=True
+    )  # ignores the base "id" field in each object
     league.equals(
         league, ignoreIds=True
     )  # ignores fields that hold an id but not the base "id" fields

example/league/manualLeagueBuildingExample.py

@@ -26,13 +26,22 @@
     # Create matchups for week 1.
     # Use the team IDs when creating a matchup.
     matchup1 = Matchup(
-        teamAId=teamFrankie2019.id, teamBId=teamDominic2019.id, teamAScore=101.2, teamBScore=122
+        teamAId=teamFrankie2019.id,
+        teamBId=teamDominic2019.id,
+        teamAScore=101.2,
+        teamBScore=122,
     )
     matchup2 = Matchup(
-        teamAId=teamMonika2019.id, teamBId=teamGiovanna2019.id, teamAScore=78.4, teamBScore=114.3
+        teamAId=teamMonika2019.id,
+        teamBId=teamGiovanna2019.id,
+        teamAScore=78.4,
+        teamBScore=114.3,
     )
     matchup3 = Matchup(
-        teamAId=teamJoseph2019.id, teamBId=teamVincent2019.id, teamAScore=112, teamBScore=145.3
+        teamAId=teamJoseph2019.id,
+        teamBId=teamVincent2019.id,
+        teamAScore=112,
+        teamBScore=145.3,
     )
 
     # Create matchups for week 2.
@@ -126,6 +135,13 @@
     # Create the league.
     league = League(
         name="G League",
-        owners=[ownerFrankie, ownerMonika, ownerJoseph, ownerVincent, ownerGiovanna, ownerDominic],
+        owners=[
+            ownerFrankie,
+            ownerMonika,
+            ownerJoseph,
+            ownerVincent,
+            ownerGiovanna,
+            ownerDominic,
+        ],
         years=[year2019],
     )

example/league/yearSettings.py

@@ -10,4 +10,6 @@
     year = Year(yearNumber=2020, teams=list(), weeks=list(), yearSettings=yearSettings)
 
     # The YearSettings object can be used for multiple years if desired
-    anotherYear = Year(yearNumber=2021, teams=list(), weeks=list(), yearSettings=yearSettings)
+    anotherYear = Year(
+        yearNumber=2021, teams=list(), weeks=list(), yearSettings=yearSettings
+    )

example/league_loader/espnLeagueLoaderExample.py

@@ -18,5 +18,7 @@
     # Get a League object with years 2019 and 2020 for ESPN league with ID: "12345678".
     espnS2 = "ABCDEFG1234567"
     swid = "{ABC-DEF-GHI-JKL-MNOP}"
-    espnLeagueLoader = ESPNLeagueLoader("12345678", [2019, 2020], espnS2=espnS2, swid=swid)
+    espnLeagueLoader = ESPNLeagueLoader(
+        "12345678", [2019, 2020], espnS2=espnS2, swid=swid
+    )
     league: League = espnLeagueLoader.loadLeague()

example/league_loader/myFantasyLeagueLeagueLoaderExample.py

@@ -16,7 +16,9 @@
 
     MFL_USERNAME = "myUsername"  # The username for your MFL account.
     MFL_PASSWORD = "myPassword"  # The password for your MFL account.
-    MFL_USER_AGENT_NAME = "myUserAgentName"  # The Client User Agent you set for your API Client.
+    MFL_USER_AGENT_NAME = (
+        "myUserAgentName"  # The Client User Agent you set for your API Client.
+    )
     LEAGUE_ID = "123456"
 
     myFantasyLeagueLoader = MyFantasyLeagueLeagueLoader(

example/league_loader/yahooLeagueLoaderExample.py

@@ -20,6 +20,10 @@
     clientId = "myClientId"
     clientSecret = "myClientSecret"
     yahooLeagueLoader = YahooLeagueLoader(
-        "123456", [2019, 2020], clientId=clientId, clientSecret=clientSecret, loginTimeoutSeconds=4
+        "123456",
+        [2019, 2020],
+        clientId=clientId,
+        clientSecret=clientSecret,
+        loginTimeoutSeconds=4,
     )
     league: League = yahooLeagueLoader.loadLeague()

example/stat/gettingStatsAllTimeExample.py

@@ -27,18 +27,22 @@
     wins = GameOutcomeAllTimeCalculator.getWins(league)
 
     # Get opponent points scored per game.
-    opponentPointsScoredPerGame = PointsScoredAllTimeCalculator.getOpponentPointsScoredPerGame(
-        league
+    opponentPointsScoredPerGame = (
+        PointsScoredAllTimeCalculator.getOpponentPointsScoredPerGame(league)
     )
 
     # To limit results to only regular season, specify that as a keyword argument.
     maxScore = SingleScoreAllTimeCalculator.getMaxScore(league, onlyRegularSeason=True)
 
     # To limit results to only post-season (playoffs), specify that as a keyword argument.
-    scoringShare = ScoringShareAllTimeCalculator.getScoringShare(league, onlyPostSeason=True)
+    scoringShare = ScoringShareAllTimeCalculator.getScoringShare(
+        league, onlyPostSeason=True
+    )
 
     # To limit results to only championship games, specify that as a keyword argument.
-    winPercentage = GameOutcomeAllTimeCalculator.getWinPercentage(league, onlyChampionship=True)
+    winPercentage = GameOutcomeAllTimeCalculator.getWinPercentage(
+        league, onlyChampionship=True
+    )
 
     # To limit results to only certain years, specify that as a keyword argument.
     # This league has years 2019, 2020, 2021, 2022.
@@ -89,5 +93,9 @@
     )
     # Will get week 5, 2020 - week 10, 2021.
     smartWins = SmartWinsAllTimeCalculator.getSmartWins(
-        league, weekNumberStart=5, yearNumberStart=2020, weekNumberEnd=10, yearNumberEnd=2021
+        league,
+        weekNumberStart=5,
+        yearNumberStart=2020,
+        weekNumberEnd=10,
+        yearNumberEnd=2021,
     )

example/stat/gettingStatsForYearExample.py

@@ -29,31 +29,41 @@
     wins = GameOutcomeYearCalculator.getWins(year2019)
 
     # Get opponent points scored per game.
-    opponentPointsScoredPerGame = PointsScoredYearCalculator.getOpponentPointsScoredPerGame(
-        year2019
+    opponentPointsScoredPerGame = (
+        PointsScoredYearCalculator.getOpponentPointsScoredPerGame(year2019)
     )
 
     # To limit results to only regular season, specify that as a keyword argument.
     maxScore = SingleScoreYearCalculator.getMaxScore(year2019, onlyRegularSeason=True)
 
     # To limit results to only post-season (playoffs), specify that as a keyword argument.
-    scoringShare = ScoringShareYearCalculator.getScoringShare(year2019, onlyPostSeason=True)
+    scoringShare = ScoringShareYearCalculator.getScoringShare(
+        year2019, onlyPostSeason=True
+    )
 
     # To limit results to only championship games, specify that as a keyword argument.
-    winPercentage = GameOutcomeYearCalculator.getWinPercentage(year2019, onlyChampionship=True)
+    winPercentage = GameOutcomeYearCalculator.getWinPercentage(
+        year2019, onlyChampionship=True
+    )
 
     # To limit results to only certain weeks, specify that as a keyword argument.
     # Let's assume this year has weeks 1-15.
 
     # Will get weeks 5-15.
-    scoringStandardDeviation = ScoringStandardDeviationYearCalculator.getScoringStandardDeviation(
-        year2019, weekNumberStart=5
+    scoringStandardDeviation = (
+        ScoringStandardDeviationYearCalculator.getScoringStandardDeviation(
+            year2019, weekNumberStart=5
+        )
     )
     # Will get weeks 1-10.
-    scoringStandardDeviation = ScoringStandardDeviationYearCalculator.getScoringStandardDeviation(
-        year2019, weekNumberEnd=10
+    scoringStandardDeviation = (
+        ScoringStandardDeviationYearCalculator.getScoringStandardDeviation(
+            year2019, weekNumberEnd=10
+        )
     )
     # Will get weeks 5-10.
-    scoringStandardDeviation = ScoringStandardDeviationYearCalculator.getScoringStandardDeviation(
-        year2019, weekNumberStart=5, weekNumberEnd=10
+    scoringStandardDeviation = (
+        ScoringStandardDeviationYearCalculator.getScoringStandardDeviation(
+            year2019, weekNumberStart=5, weekNumberEnd=10
+        )
     )

leeger/calculator/all_time_calculator/AWALAllTimeCalculator.py

@@ -92,11 +92,15 @@ def getOpponentAWAL(cls, league: League, **kwargs) -> dict[str, Optional[Deci]]:
             ...
             }
         """
-        return cls._addAndCombineResults(league, AWALYearCalculator.getOpponentAWAL, **kwargs)
+        return cls._addAndCombineResults(
+            league, AWALYearCalculator.getOpponentAWAL, **kwargs
+        )
 
     @classmethod
     @validateLeague
-    def getOpponentAWALPerGame(cls, league: League, **kwargs) -> dict[str, Optional[Deci]]:
+    def getOpponentAWALPerGame(
+        cls, league: League, **kwargs
+    ) -> dict[str, Optional[Deci]]:
         """
         Returns the number of Adjusted Wins Against the League per game for each Owner's opponent in the given League.
         Returns None for an Owner if they have no games played in the range.
@@ -124,7 +128,8 @@ def getOpponentAWALPerGame(cls, league: League, **kwargs) -> dict[str, Optional[
                 ownerIdAndOpponentAWALPerGame[ownerId] = None
             else:
                 ownerIdAndOpponentAWALPerGame[ownerId] = (
-                    ownerIdAndOpponentAWAL[ownerId] / ownerIdAndNumberOfGamesPlayed[ownerId]
+                    ownerIdAndOpponentAWAL[ownerId]
+                    / ownerIdAndNumberOfGamesPlayed[ownerId]
                 )
 
         return ownerIdAndOpponentAWALPerGame