Merge pull request #273 from practical-python-org/buildcache

fix: better build cacheing

Author: Xarlos89

Dockerfile

@@ -2,9 +2,22 @@ FROM python:3.11.6-slim-bullseye AS builder-image
 
 ENV PYTHONUNBUFFERED=1
 
-COPY . /code
 WORKDIR /code
 
-RUN pip install . && apt-get update && apt-get install -y ffmpeg
+RUN apt-get update && apt-get install -y ffmpeg
+
+COPY requirements.txt /code/
+
+RUN pip install -r requirements.txt
+
+COPY setup.py /code/setup.py
+COPY setup.cfg /code/setup.cfg
+COPY versioneer.py /code/versioneer.py
+COPY pyproject.toml /code/pyproject.toml
+COPY README.md /code/README.md
+COPY src /code/src
+
+RUN pip uninstall -y zorak && \
+    pip install .
 
 ENTRYPOINT ["zorak"]

README.md

@@ -31,17 +31,15 @@ The easiest way to get started is to run Zorak locally and in our test server (C
 - -cl: Flag that enables streaming logs to console.
 
 ```bash
-pip install .
-zorak -dt <DISCORD_TOKEN_HERE> -ssp Resources/ServerConfig/Zorak-Dev -dd True -cl True
+docker-compose up -d
 ```
-If you need to spin up the docker instances, you can by editing the .env file to reflect dev settings.
-1. Update the .env file to use 'dev' as the ENVIRONMENT
-2. Update your .env file to point the SETTINGS variable to Resources/ServerConfig/Zorak-Dev
-3. Run the command
+And then after making a change, rebuild only zorak.
 ```bash
-docker-compose up -d
+docker build -t zorak .
+docker run --env-file ./.env zorak -dd True -dt <DISCORD_TOKEN_HERE>
 ```
 
+
 ### Production
 All environment settings are found in your .env file.
 1. Update the .env file to use 'prod' as the ENVIRONMENT
@@ -99,3 +97,4 @@ If your PR title does not include any of the specified prefixes, the GitHub Acti
 When your PR is merged into main, the GitHub Action will increment the version according to the prefix in the PR title and create a new tag.
 
 Please ensure you follow this convention to maintain a well-structured and meaningful version history for our project.
+

requirements.txt

@@ -0,0 +1,16 @@
+py-cord
+beautifulsoup4
+requests
+matplotlib
+DateTime
+pytz
+pistonapi
+toml
+feedparser
+html2text
+pymongo
+PyNaCl==1.5.0
+ffmpeg-python==0.2.0
+yt-dlp==2023.10.13
+googletrans==3.1.0a0
+dnspython==2.3.0

setup.py

@@ -1,7 +1,15 @@
+import pathlib
+
+import pkg_resources
 import setuptools
 
 import versioneer
 
+install_requires = []
+with pathlib.Path("requirements.txt").open() as requirements_txt:
+    install_requires = [str(requirement) for requirement in pkg_resources.parse_requirements(requirements_txt)]
+
+
 setuptools.setup(
     name="zorak",
     description="An installable version of the Zorak.",
@@ -14,24 +22,7 @@
     packages=setuptools.find_packages(where="src"),
     entry_points={"console_scripts": ["zorak=zorak.__main__:main"]},
     package_data={"": ["*.toml"]},
-    install_requires=[
-        "py-cord",
-        "beautifulsoup4",
-        "requests",
-        "matplotlib",
-        "DateTime",
-        "pytz",
-        "pistonapi",
-        "toml",
-        "feedparser",
-        "html2text",
-        "pymongo",
-        "PyNaCl==1.5.0",
-        "ffmpeg-python==0.2.0",
-        "yt-dlp==2023.10.13",
-        "googletrans==3.1.0a0",
-        "dnspython==2.3.0"
-    ],
+    install_requires=install_requires,
     classifiers=[
         # see https://pypi.org/classifiers/
         "Development Status :: 5 - Production/Stable",

src/zorak/cogs/admin/admin_startup.py

@@ -7,14 +7,14 @@
 
 from discord.ext import commands
 
-
 logger = logging.getLogger(__name__)
 
 
 class OnStartup(commands.Cog):
     """
     onStartup is called when the bot reaches a stable state.
     """
+
     def __init__(self, bot):
         self.bot = bot
 
@@ -23,11 +23,7 @@ async def on_ready(self):
         """
         Here's the juice. It's literally logging.
         """
-        logger.info(
-            "Successfully logged in as {%s}/ ID: {%s}"
-            , self.bot.user
-            , self.bot.user.id
-        )
+        logger.info("Successfully logged in as {%s}/ ID: {%s}", self.bot.user, self.bot.user.id)
         logger.info("Started at: {%s}", datetime.now())
         logger.info("Greetings, puny earth-creature.")