├── .devcontainer └── devcontainer.json ├── .gitignore ├── README.md ├── app.py └── requirements.txt /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "GitHub Copilot - Flask Starter", 3 | "image": "mcr.microsoft.com/devcontainers/universal:2", 4 | "hostRequirements": { 5 | "cpus": 4 6 | }, 7 | "waitFor": "onCreateCommand", 8 | "updateContentCommand": "pip install -r requirements.txt", 9 | "postCreateCommand": "", 10 | "postAttachCommand": { 11 | "server": "flask --debug run" 12 | }, 13 | "portsAttributes": { 14 | "5000": { 15 | "label": "Application", 16 | "onAutoForward": "openPreview" 17 | } 18 | }, 19 | "customizations": { 20 | "vscode": { 21 | "extensions": [ 22 | "ms-python.python" 23 | ] 24 | } 25 | }, 26 | "forwardPorts": [ 27 | 5000 28 | ] 29 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GitHub Copilot Starter 2 | 3 | This is a basic [Flask][Flask] web app to demonstrate the functionality of [GitHub Copilot][Copilot] as part of the sponsored [Making Better Hacks, Faster with GitHub Copilot][Presentation] presentation. 4 | 5 | [Flask]: https://flask.palletsprojects.com/ 6 | [Copilot]: https://github.com/features/copilot 7 | [Presentation]: https://docs.google.com/presentation/d/1iGk2JK5IZswqVW9ES3dFw074FEeSXUssHooaT3WthKM/edit 8 | 9 | ## Getting Started 10 | 11 | ### 1. Clone the Repository 12 | 13 | To use this app, first, clone the package to your local machine. 14 | 15 | git clone https://github.com/mlh/copilot-starter 16 | 17 | _If you're using Visual Studio Code, this can be done by using the command pallet (`Ctrl-⇧-P` / `⌘-⇧-P`) and selecting `Git: Clone`, then typing `mlh/copilot-starter`._ 18 | 19 | ### 2. Install the required packages 20 | 21 | Using pip, you'll need to install the packages this project uses. The following command reads the requirements from requirements.txt and installs them. 22 | 23 | pip install -r requirements.txt 24 | 25 | _This assumes you have python and pip already installed, if you do not, you'll need to [install them](https://wiki.python.org/moin/BeginnersGuide/Download). On a Mac, you may need to type `pip3` rather than `pip`._ 26 | 27 | _If you're using Visual Studio Code, you can open a terminal by using the command pallet (`Ctrl-⇧-P` / `⌘-⇧-P`) and selecting `Python: Create Terminal`._ 28 | 29 | ### 3. Run the Flask app 30 | 31 | To run the Flask app, you can use the following command, this uses Flask to execute code in `app.py`. 32 | 33 | python -m flask run --debug 34 | 35 | _This command will fail, see the [next steps, below](#2-fix-issues), for how to fix it._ 36 | 37 | ## Trying out GitHub Copilot 38 | 39 | GitHub Copilot has a number of great features you can try. GitHub has a great [Getting Started Guide](https://docs.github.com/en/copilot/using-github-copilot/getting-started-with-github-copilot) which covers some of the features this project covers. 40 | 41 | In Visual Studio Code, you can access GitHub Copilot by using the Copilot key command `Ctrl-I` / `⌘-I`, this guide assumes you're using Visual Studio Code and makes suggestions as though you are. 42 | 43 | ### 1. Explain the code 44 | 45 | Copilot can explain what code does, you can select a section of code or have it explain the whole file. 46 | 47 | 1. Highlight the code you want Copilot to explain.\ 48 | _With `app.py` open, try selecting all of it._ 49 | 2. Open Copilot (`Ctrl-I` / `⌘-I`) 50 | 3. Type `/explain`. \ 51 | _You can have Copilot explain the file generally, or as specific questions like `/explain Why is is int() used?`_ 52 | 53 | This is great when you come across a project you've never seen before or if a teammate introduced a method with some functions you don't recognize. 54 | 55 | ### 2. Fix Issues 56 | 57 | The Flask app as written has a bug in it which you'll see [if you run the app](#3-run-the-flask-app). You can have Copilot propose fixes. 58 | 59 | 1. Open Copilot (`Ctrl-I` / `⌘-I`) 60 | 2. Type `/fix`. \ 61 | _Copilot works even better if you give it an error message or highlight the part of the code that's broken, like `/fix TypeError: The view function did not return a valid response.`_ 62 | 63 | If you accept the change, you should (likely) now be able to run the application. With your [app running](#3-run-the-flask-app) and navigate to you should see a string of numbers (the seconds since the Unix epoch). 64 | 65 | ### 3. Write Code 66 | 67 | You can use Copilot to write code. 68 | 69 | 1. Open Copilot (`Ctrl-I` / `⌘-I`) 70 | 2. Give Copilot a prompt, like `add a route that shows hours since the epoch`. 71 | 72 | Copilot will make a suggestion for code that will work. For a simple application like this one, it will most likely work perfectly. For more complicated applications you may need to evaluate the code yourself to make sure it does what you expect. 73 | 74 | ### 4. Suggest Code 75 | 76 | Just like a human pair programmer, Copilot is actively along side you as you program. You can just type code and Copilot will suggest autocompletions. 77 | 78 | 1. Start writing a new function, typing something like `def days_since_epoch():` 79 | 2. Hit `Tab ↹` after Copilot makes a suggestion. 80 | 81 | _Try making a companion route to go with this and have Copilot help you there._ 82 | -------------------------------------------------------------------------------- /app.py: -------------------------------------------------------------------------------- 1 | from flask import Flask 2 | import time 3 | 4 | app = Flask(__name__) 5 | 6 | def seconds_since_epoch(): 7 | epoch = time.time() 8 | return int(epoch) 9 | 10 | @app.route("/") 11 | def seconds(): 12 | return seconds_since_epoch() 13 | 14 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Flask==3.0.0 2 | --------------------------------------------------------------------------------