Merge branch 'master' into patch-1

Author: dbader

.circleci/config.yml

@@ -39,3 +39,9 @@ jobs:
             . venv/bin/activate
             flake8
             black --check .
+
+      - run:
+          name: Directory layout check
+          command: |
+            . venv/bin/activate
+            python .circleci/dircheck.py

.circleci/dircheck.py

@@ -0,0 +1,72 @@
+"""
+Linter to ensure standard folder structure
+"""
+import pathlib
+import re
+import sys
+
+IGNORELIST = {
+    "venv",
+    "asyncio-walkthrough",
+    "build-a-gui-with-wxpython",
+    "consuming-apis-python",
+    "flask-connexion-rest-part-3",
+    "flask-connexion-rest-part-4",
+    "generators",
+    "intro-to-threading",
+    "introduction-combining-data-pandas-merge-join-and-concat",
+    "linked-lists-python",
+    "nearbyshops",
+    "oop-in-java-vs-python",
+    "opencv-color-spaces",
+    "openpyxl-excel-spreadsheets-python",
+    "pygame-a-primer",
+    "pyqt-calculator-tutorial",
+    "python-dash",
+    "python-eval-mathrepl",
+    "rp-portfolio",
+    "storing-images",
+    "understanding-asynchronous-programming",
+}
+FOLDER_NAME_RE = re.compile(r"^[-a-z0-9]{5,}\Z")
+
+has_errors = False
+
+for f in sorted(pathlib.Path(".").glob("*")):
+    if not f.is_dir():
+        continue
+    if str(f).startswith("."):
+        continue
+    if str(f) in IGNORELIST:
+        continue
+
+    if not FOLDER_NAME_RE.search(str(f)):
+        print(
+            f"{f}: ensure folder name only uses "
+            f"lowercase letters, numbers, and hyphens"
+        )
+        has_error = True
+
+    files = sorted(_.name for _ in f.glob("*"))
+    if "README.md" not in files:
+        print(f"{f}: no README.md found")
+        has_errors = True
+
+if has_errors:
+    print(
+        """-----------------------
+Please ensure new sample projects are added using the correct
+folder structure:
+
+  * New files should go into a top-level subfolder, named after the
+    article slug (lowercase, dashes). For example: my-awesome-article/
+
+  * Top-level sample project folders should contain a README.md file.
+    For example: my-awesome-article/README.md
+
+This helps us keep the repo clean and easy to browse on GitHub.
+
+Thanks!
+"""
+    )
+    sys.exit(1)

.dependabot/config.yml

@@ -0,0 +1,42 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+:information_source: Please note that the best way to get support for Real Python courses & articles is to join one of our [weekly Office Hours calls](https://realpython.com/office-hours/) or in the [RP Community Slack](https://realpython.com/community/). 
+
+You can report issues and problems here, but we typically won't be able to provide 1:1 support outside the channels listed above.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: monthly
+  open-pull-requests-limit: 10
+  allow:
+  - dependency-name: flake8
+  - dependency-name: black

.github/dependabot.yml

@@ -108,3 +108,6 @@ ENV/
 
 # Mac
 *.DS_Store
+
+# VS Code workspace
+*.code-workspace

.gitignore

@@ -1,10 +1,18 @@
 # Real Python Materials
 
-Bonus materials, exercises, and example projects for our [Python tutorials](https://realpython.com).
+Bonus materials, exercises, and example projects for Real Python's [Python tutorials](https://realpython.com).
 
 Build Status: [![CircleCI](https://circleci.com/gh/realpython/materials.svg?style=svg)](https://circleci.com/gh/realpython/materials)
 
-## Running Code Style Checks
+## Got a Question?
+
+The best way to get support for Real Python courses & articles and code in this repository is to join one of our [weekly Office Hours calls](https://realpython.com/office-hours/) or to ask your question in the [RP Community Slack](https://realpython.com/community/). 
+
+Due to time constraints we cannot provide 1:1 support via GitHub. See you on Slack or on the next Office Hours call 🙂
+
+## Adding Source Code & Sample Projects to This Repo (RP Contributors)
+
+### Running Code Style Checks
 
 We use [flake8](http://flake8.pycqa.org/en/latest/) and [black](https://github.com/ambv/black) to ensure a consistent code style for all of our sample code in this repository.
 
@@ -15,7 +23,7 @@ $ flake8
 $ black --check .
 ```
 
-## Running Python Code Formatter
+### 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. 
 

README.md

@@ -14,12 +14,10 @@
 
 
 class Welcome(arcade.Window):
-    """Our main welcome window
-    """
+    """Our main welcome window"""
 
     def __init__(self):
-        """Initialize the window
-        """
+        """Initialize the window"""
 
         # Call the parent class constructor
         super().__init__(SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_TITLE)
@@ -28,8 +26,7 @@ def __init__(self):
         arcade.set_background_color(arcade.color.WHITE)
 
     def on_draw(self):
-        """Called whenever we need to draw our window
-        """
+        """Called whenever we need to draw our window"""
 
         # Clear the screen and start drawing
         arcade.start_render()

arcade-a-primer/arcade_basic_oop.py

@@ -13,12 +13,10 @@
 
 
 class Welcome(arcade.Window):
-    """Our main welcome window
-    """
+    """Our main welcome window"""
 
     def __init__(self):
-        """Initialize the window
-        """
+        """Initialize the window"""
 
         # Call the parent class constructor
         super().__init__(SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_TITLE)
@@ -27,8 +25,7 @@ def __init__(self):
         arcade.set_background_color(arcade.color.WHITE)
 
     def on_draw(self):
-        """Called whenever we need to draw our window
-        """
+        """Called whenever we need to draw our window"""
 
         # Clear the screen and start drawing
         arcade.start_render()

arcade-a-primer/arcade_draw_shapes.py

@@ -41,8 +41,7 @@ class SpaceShooter(arcade.Window):
     """
 
     def __init__(self, width: int, height: int, title: str):
-        """Initialize the game
-        """
+        """Initialize the game"""
         super().__init__(width, height, title)
 
         # Setup the empty sprite lists
@@ -51,8 +50,7 @@ def __init__(self, width: int, height: int, title: str):
         self.all_sprites = arcade.SpriteList()
 
     def setup(self):
-        """Get the game ready to play
-        """
+        """Get the game ready to play"""
 
         # Set the background color
         arcade.set_background_color(arcade.color.SKY_BLUE)
@@ -236,8 +234,7 @@ def on_update(self, delta_time: float):
             self.player.left = 0
 
     def on_draw(self):
-        """Draw all game objects
-        """
+        """Draw all game objects"""
 
         arcade.start_render()
         self.all_sprites.draw()