Merge branch 'master' into martin-update-bootstrap

Author: dbader

.circleci/config.yml

@@ -16,7 +16,7 @@ jobs:
       # Download and cache dependencies
       - restore_cache:
           keys:
-          - v1-dependencies-{{ checksum ".circleci/requirements.txt" }}
+          - v1-dependencies-{{ checksum "requirements.txt" }}
           # fallback to using the latest cache if no exact match is found
           - v1-dependencies-
 
@@ -26,12 +26,12 @@ jobs:
             python3 -m venv venv
             . venv/bin/activate
             pip install --upgrade pip
-            pip install -r .circleci/requirements.txt
+            pip install -r requirements.txt
 
       - save_cache:
           paths:
             - ./venv
-          key: v1-dependencies-{{ checksum ".circleci/requirements.txt" }}
+          key: v1-dependencies-{{ checksum "requirements.txt" }}
 
       - run:
           name: Code style check

.circleci/requirements.txt

@@ -1,6 +1,10 @@
+**Where to put new files:**
+
+- New files should go into a top-level subfolder, named after the article slug. For example: `my-awesome-article`
+
 **How to merge your changes:** 
 
-1. Make sure the CI code style tests all pass. 
+1. [Make sure the CI code style tests all pass (+ run the automatic code formatter if necessary).](https://github.com/realpython/materials/blob/master/README.md)
 2. Find an RP Team member on Slack and ask them to review & approve your PR.
 3. Once the PR has one positive ("approved") review, GitHub lets you merge the PR.
 4. 🎉

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,6 +17,10 @@ $ black --check .
 
 ## Running Python Code Formatter
 
+We're using a tool called [black](https://github.com/ambv/black) on this repo to ensure consistent formatting. On CI it runs in "check" mode to ensure any new files added to the repo are following PEP 8. If you see linter warnings that say something like "would reformat some_file.py" it means black disagrees with your formatting. 
+
+**The easiest way to resolve these errors is to just run Black locally on the code and then committing those changes, as explained below.**
+
 To automatically re-format your code to be consistent with our code style guidelines, run [black](https://github.com/ambv/black) in the repository root folder:
 
 ```sh

README.md

@@ -0,0 +1 @@
+Source files supporting the **Arcade - A Modern Python Game Framework** article

arcade-a-primer/README.md

@@ -0,0 +1,31 @@
+# Basic arcade program
+# Displays a white window with a blue circle in the middle
+
+# Imports
+import arcade
+
+# Constants
+SCREEN_WIDTH = 600
+SCREEN_HEIGHT = 800
+SCREEN_TITLE = "Welcome to Arcade"
+RADIUS = 150
+
+# Open the window
+arcade.open_window(SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_TITLE)
+
+# Set the background color
+arcade.set_background_color(arcade.color.WHITE)
+
+# Clear the screen and start drawing
+arcade.start_render()
+
+# Draw a blue circle
+arcade.draw_circle_filled(
+    SCREEN_WIDTH / 2, SCREEN_HEIGHT / 2, RADIUS, arcade.color.BLUE
+)
+
+# Finish drawing
+arcade.finish_render()
+
+# Display everything
+arcade.run()

arcade-a-primer/arcade_basic.py

@@ -0,0 +1,46 @@
+# Basic arcade program using objects
+# Displays a white window with a blue circle in the middle
+
+# Imports
+import arcade
+
+# Constants
+SCREEN_WIDTH = 600
+SCREEN_HEIGHT = 800
+SCREEN_TITLE = "Welcome to Arcade"
+RADIUS = 150
+
+# Classes
+
+
+class Welcome(arcade.Window):
+    """Our main welcome window
+    """
+
+    def __init__(self):
+        """Initialize the window
+        """
+
+        # Call the parent class constructor
+        super().__init__(SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_TITLE)
+
+        # Set the background window
+        arcade.set_background_color(arcade.color.WHITE)
+
+    def on_draw(self):
+        """Called whenever we need to draw our window
+        """
+
+        # Clear the screen and start drawing
+        arcade.start_render()
+
+        # Draw a blue circle
+        arcade.draw_circle_filled(
+            SCREEN_WIDTH / 2, SCREEN_HEIGHT / 2, RADIUS, arcade.color.BLUE
+        )
+
+
+# Main code entry point
+if __name__ == "__main__":
+    app = Welcome()
+    arcade.run()

arcade-a-primer/arcade_basic_oop.py

@@ -0,0 +1,85 @@
+# Basic arcade program using objects
+# Draw shapes on screen
+
+# Imports
+import arcade
+
+# Constants
+SCREEN_WIDTH = 600
+SCREEN_HEIGHT = 650
+SCREEN_TITLE = "Draw Shapes"
+
+# Classes
+
+
+class Welcome(arcade.Window):
+    """Our main welcome window
+    """
+
+    def __init__(self):
+        """Initialize the window
+        """
+
+        # Call the parent class constructor
+        super().__init__(SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_TITLE)
+
+        # Set the background window
+        arcade.set_background_color(arcade.color.WHITE)
+
+    def on_draw(self):
+        """Called whenever we need to draw our window
+        """
+
+        # Clear the screen and start drawing
+        arcade.start_render()
+
+        # Draw a blue arc
+        arcade.draw_arc_filled(100, 100, 40, 40, arcade.color.BLUE, 0, 125)
+
+        # Draw a red ellipse
+        arcade.draw_ellipse_outline(
+            300, 100, 60, 30, arcade.color.RED, border_width=2
+        )
+
+        # Draw some purple lines
+        arcade.draw_line(500, 100, 550, 100, arcade.color.PURPLE)
+        arcade.draw_line(500, 90, 550, 90, arcade.color.PURPLE, line_width=2)
+        arcade.draw_line(500, 80, 550, 80, arcade.color.PURPLE, line_width=3)
+
+        # Draw an orange parabola
+        arcade.draw_parabola_filled(100, 100, 130, 120, arcade.color.ORANGE)
+
+        # Draw a black point
+        arcade.draw_point(300, 300, arcade.color.BLACK, 20)
+
+        # Draw a green polygon
+        points_list = [
+            [500, 300],
+            [550, 300],
+            [575, 325],
+            [550, 350],
+            [525, 340],
+        ]
+        arcade.draw_polygon_outline(
+            points_list, arcade.color.GREEN, line_width=5
+        )
+
+        # Draw some rectangles
+        arcade.draw_rectangle_filled(100, 500, 150, 75, arcade.color.AZURE)
+        arcade.draw_lrtb_rectangle_filled(
+            150, 250, 575, 525, arcade.color.AMARANTH_PINK
+        )
+        arcade.draw_xywh_rectangle_filled(
+            200, 550, 150, 75, arcade.color.ASPARAGUS
+        )
+
+        # Draw some triangles
+        arcade.draw_triangle_filled(
+            400, 500, 500, 500, 450, 575, arcade.color.DEEP_RUBY
+        )
+
+
+# Main code entry point
+if __name__ == "__main__":
+    app = Welcome()
+    arcade.run()