Updated Requirements + Admin (#32)

- Updated requirements
- Formatted code
- Added Makefile

.github/workflows/formatting-check.yml

@@ -30,14 +30,8 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install black==23.3.0
+          make deps
 
       - name: Check Formatting
         run: |
-          black --config pyproject.toml --check --diff .
-
-      - name: Install autoflake
-        run: pip install autoflake==2.1.1
-
-      - name: Check for Unused Imports
-        run: autoflake --config pyproject.toml --check .
+          make fmt-check

.github/workflows/main-build.yml

@@ -5,35 +5,27 @@ name: Main Build
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 permissions:
   contents: read
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v3
-      with:
-        python-version: "3.10"
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Test with pytest
-      run: |
-        pytest
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          make deps
+      - name: Run unit tests
+        run: |
+          make test

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
-- N/A
+- Updated package requirements
 
 ## [1.7.0]
 

Makefile

@@ -0,0 +1,24 @@
+.PHONY: deps
+deps:
+	@python3 -m pip install -r requirements.dev.txt
+	@python3 -m pip install -r requirements.txt
+
+.PHONY: fmt
+fmt:
+	@black --config=pyproject.toml .
+	@autoflake --config=pyproject.toml .
+	@isort .
+
+.PHONY: fmt-check
+fmt-check:
+	@black --config=pyproject.toml --check .
+	@autoflake --config=pyproject.toml --check .
+	@isort --check-only .
+
+.PHONY: test
+test:
+	@pytest test/
+
+.PHONY: up-reqs
+up-reqs:
+	@pipreqs --force

README.md

@@ -34,9 +34,9 @@ Please make sure to update tests as appropriate.
 ## Development
 
 _Run these commands from the root folder_
-- Format Code: `./main fmt`
-- Run Unit Tests: `./main test`
-- Generate Coverage Report: `./main cov`
+- Install Dependencies: `make deps`
+- Format Code: `make fmt`
+- Run Unit Tests: `make test`
 
 ## License
 

example/draft_example.py

@@ -1,8 +1,6 @@
 from sleeper.api import DraftAPIClient
 from sleeper.enum import Sport
-from sleeper.model import Draft
-from sleeper.model import DraftPick
-from sleeper.model import PlayerDraftPick
+from sleeper.model import Draft, DraftPick, PlayerDraftPick
 
 if __name__ == "__main__":
     # get all drafts that a user was in for a particular year

example/league_example.py

@@ -2,13 +2,13 @@
 from sleeper.enum import Sport
 from sleeper.model import (
     League,
-    Roster,
-    User,
     Matchup,
     PlayoffMatchup,
-    Transaction,
-    TradedPick,
+    Roster,
     SportState,
+    TradedPick,
+    Transaction,
+    User,
 )
 
 if __name__ == "__main__":

requirements.format.txt → requirements.dev.txt

@@ -1,3 +1,4 @@
 black==23.3.0
 autoflake==2.1.1
-isort==5.12.0
+isort==5.12.0
+pytest==7.4.3

requirements.txt

@@ -1,4 +1,3 @@
-requests~=2.28.2
-configparser~=5.3.0
-setuptools~=66.1.1
-Pillow~=9.4.0
+Pillow==10.1.0
+Requests==2.31.0
+setuptools==69.0.2

sleeper/api/unofficial/UPlayerAPIClient.py

@@ -1,7 +1,7 @@
 from typing import Any
 
 from sleeper.api.SleeperAPIClient import SleeperAPIClient
-from sleeper.enum import SeasonType, PlayerPosition
+from sleeper.enum import PlayerPosition, SeasonType
 from sleeper.enum.Sport import Sport
 from sleeper.model.PlayerStats import PlayerStats
 

sleeper/enum/ModelEnum.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from enum import unique, Enum
+from enum import Enum, unique
 
 from sleeper.util.CustomLogger import CustomLogger
 

sleeper/enum/PlayerPosition.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from abc import abstractmethod
-from enum import unique, Enum
+from enum import Enum, unique
 
 from sleeper.enum.Sport import Sport
 

sleeper/enum/PlayerStatus.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from abc import abstractmethod
-from enum import unique, Enum
+from enum import Enum, unique
 
 from sleeper.enum.Sport import Sport
 

sleeper/enum/RosterPosition.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
 from abc import abstractmethod
-from enum import unique, Enum
+from enum import Enum, unique
 
-from sleeper.enum.Sport import Sport
 from sleeper.enum.nfl.NFLRosterPosition import NFLRosterPosition
+from sleeper.enum.Sport import Sport
 
 
 @unique

sleeper/enum/SportTeam.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from abc import abstractmethod
-from enum import unique, Enum
+from enum import Enum, unique
 
 from sleeper.enum.Sport import Sport
 

sleeper/model/Game.py

@@ -3,7 +3,7 @@
 import datetime
 from dataclasses import dataclass
 
-from sleeper.enum import SportTeam, Sport
+from sleeper.enum import Sport, SportTeam
 from sleeper.enum.SeasonStatus import SeasonStatus
 
 

sleeper/model/PlayerStats.py

@@ -3,7 +3,7 @@
 import datetime
 from dataclasses import dataclass
 
-from sleeper.enum import SportTeam, Sport, SeasonType
+from sleeper.enum import SeasonType, Sport, SportTeam
 from sleeper.enum.Category import Category
 from sleeper.enum.Company import Company
 from sleeper.model import Player

test/test_api/test_AvatarAPIClient.py

@@ -1,13 +1,13 @@
 import os
 import tempfile
 import unittest
+from test.helper.helper_classes import MockResponse
 from unittest import mock
 
 from requests import HTTPError
 
 from sleeper.api.AvatarAPIClient import AvatarAPIClient
 from sleeper.exception.SleeperAPIException import SleeperAPIException
-from test.helper.helper_classes import MockResponse
 
 
 class TestAvatarAPIClient(unittest.TestCase):

test/test_api/test_DraftAPIClient.py

@@ -1,4 +1,5 @@
 import unittest
+from test.helper.helper_classes import MockResponse
 from unittest import mock
 
 from requests import HTTPError
@@ -7,19 +8,18 @@
 from sleeper.enum.DraftStatus import DraftStatus
 from sleeper.enum.DraftType import DraftType
 from sleeper.enum.InjuryStatus import InjuryStatus
-from sleeper.enum.ScoringType import ScoringType
-from sleeper.enum.SeasonType import SeasonType
-from sleeper.enum.Sport import Sport
 from sleeper.enum.nfl.NFLPlayerStatus import NFLPlayerStatus
 from sleeper.enum.nfl.NFLPosition import NFLPosition
 from sleeper.enum.nfl.NFLTeam import NFLTeam
+from sleeper.enum.ScoringType import ScoringType
+from sleeper.enum.SeasonType import SeasonType
+from sleeper.enum.Sport import Sport
 from sleeper.model.Draft import Draft
 from sleeper.model.DraftMetadata import DraftMetadata
 from sleeper.model.DraftPick import DraftPick
 from sleeper.model.DraftSettings import DraftSettings
 from sleeper.model.PlayerDraftPick import PlayerDraftPick
 from sleeper.model.PlayerDraftPickMetadata import PlayerDraftPickMetadata
-from test.helper.helper_classes import MockResponse
 
 
 class TestDraftAPIClient(unittest.TestCase):

test/test_api/test_LeagueAPIClient.py

@@ -1,17 +1,18 @@
 import datetime
 import unittest
+from test.helper.helper_classes import MockResponse
 from unittest import mock
 
 from requests import HTTPError
 
 from sleeper.api import LeagueAPIClient
+from sleeper.enum.nfl.NFLRosterPosition import NFLRosterPosition
 from sleeper.enum.PlayoffRoundType import PlayoffRoundType
 from sleeper.enum.SeasonStatus import SeasonStatus
 from sleeper.enum.SeasonType import SeasonType
 from sleeper.enum.Sport import Sport
 from sleeper.enum.TransactionStatus import TransactionStatus
 from sleeper.enum.TransactionType import TransactionType
-from sleeper.enum.nfl.NFLRosterPosition import NFLRosterPosition
 from sleeper.model.FAABTransaction import FAABTransaction
 from sleeper.model.FromPlayoffMatchup import FromPlayoffMatchup
 from sleeper.model.League import League
@@ -26,7 +27,6 @@
 from sleeper.model.Transaction import Transaction
 from sleeper.model.TransactionSettings import TransactionSettings
 from sleeper.model.User import User
-from test.helper.helper_classes import MockResponse
 
 
 class TestLeagueAPIClient(unittest.TestCase):

test/test_api/test_PlayerAPIClient.py

@@ -1,20 +1,20 @@
 import datetime
 import unittest
+from test.helper.helper_classes import MockResponse
 from unittest import mock
 
 from requests import HTTPError
 
 from sleeper.api.PlayerAPIClient import PlayerAPIClient
 from sleeper.enum.InjuryStatus import InjuryStatus
-from sleeper.enum.PracticeParticipation import PracticeParticipation
-from sleeper.enum.Sport import Sport
-from sleeper.enum.TrendType import TrendType
 from sleeper.enum.nfl.NFLPlayerStatus import NFLPlayerStatus
 from sleeper.enum.nfl.NFLPosition import NFLPosition
 from sleeper.enum.nfl.NFLTeam import NFLTeam
+from sleeper.enum.PracticeParticipation import PracticeParticipation
+from sleeper.enum.Sport import Sport
+from sleeper.enum.TrendType import TrendType
 from sleeper.model.Player import Player
 from sleeper.model.PlayerTrend import PlayerTrend
-from test.helper.helper_classes import MockResponse
 
 
 class TestPlayerAPIClient(unittest.TestCase):

test/test_api/test_UserAPIClient.py

@@ -1,11 +1,11 @@
 import unittest
+from test.helper.helper_classes import MockResponse
 from unittest import mock
 
 from requests import HTTPError
 
 from sleeper.api.UserAPIClient import UserAPIClient
 from sleeper.model.User import User
-from test.helper.helper_classes import MockResponse
 
 
 class TestUserAPIClient(unittest.TestCase):

test/test_api/test_unofficial/test_UPlayerAPIClient.py

@@ -1,15 +1,15 @@
 import os
 import tempfile
 import unittest
+from test.helper.helper_classes import MockResponse
 from unittest import mock
 
 from sleeper.api.unofficial import UPlayerAPIClient
-from sleeper.enum import SeasonType, Company, Category
+from sleeper.enum import Category, Company, SeasonType
+from sleeper.enum.nfl import NFLPosition, NFLTeam
 from sleeper.enum.Sport import Sport
-from sleeper.enum.nfl import NFLTeam, NFLPosition
-from sleeper.model import PlayerStats, Player
+from sleeper.model import Player, PlayerStats
 from sleeper.model.nfl import NFLStats
-from test.helper.helper_classes import MockResponse
 
 
 class TestUPlayerAPIClient(unittest.TestCase):