Skip to content
This repository was archived by the owner on Feb 22, 2020. It is now read-only.

Add temporary file to test the CI configuration #1

Closed
wants to merge 23 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
0c2cf23
Add temporary file to test the CI configuration
SebastiaanZ Jan 13, 2020
9be3615
Add python version check
SebastiaanZ Jan 13, 2020
57df063
Add Python version check to stderr
SebastiaanZ Jan 13, 2020
b1f8e2d
Add Getting Started section to README
SebastiaanZ Jan 13, 2020
9c2ccb8
Add screenshot of failing build
SebastiaanZ Jan 13, 2020
85f40e2
Add Code Style and Readability section to README
SebastiaanZ Jan 13, 2020
f860f89
Crop failing_build.png to exclude text
SebastiaanZ Jan 13, 2020
608d4b6
Add "Useful Information" and "Sponsors" sections
SebastiaanZ Jan 13, 2020
757eaf0
Add sponsor logos and update Useful Information
SebastiaanZ Jan 13, 2020
a83b942
Add linode to Partners and Sponsors section
SebastiaanZ Jan 13, 2020
39696f1
Reword Useful Information section
SebastiaanZ Jan 13, 2020
a1556a6
Correct spelling mistake in README
SebastiaanZ Jan 13, 2020
5cb567c
Place shields below banner.
scragly Jan 13, 2020
4999335
Linkify the fork action in the readme.
scragly Jan 13, 2020
e2d867d
Section the intro for easier glanceability
scragly Jan 13, 2020
44d1c08
Getting Started: Add headers, tiny wording adjustment
scragly Jan 13, 2020
be89312
Add `.flake8` files to team folders
SebastiaanZ Jan 13, 2020
bd9f0ac
Remove unnecessary mention of E227
SebastiaanZ Jan 13, 2020
71e6e4c
Remove E226 from flake8 configuration files
SebastiaanZ Jan 13, 2020
353ee2a
Remove --ignore=E226 from azure configuration
SebastiaanZ Jan 13, 2020
9c90aa4
Add --isolated to make flake8 ignore config files
SebastiaanZ Jan 13, 2020
7d59044
Header the Considerations section.
scragly Jan 14, 2020
f19b200
Add test for --isolated flag
SebastiaanZ Jan 17, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 79 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,90 @@
[![Code Jam Banner](https://raw.githubusercontent.com/python-discord/code-jam-6/master/ancient%20tech.png?token=AAQAKVPQ55SEFWYYLYO5YV26ETLTC)](#)

![Code Jam Banner](https://raw.githubusercontent.com/python-discord/code-jam-6/master/ancient%20tech.png?token=AAQAKVPQ55SEFWYYLYO5YV26ETLTC)
[![Discord](https://img.shields.io/static/v1?label=Python%20Discord&logo=discord&message=%3E30k%20members&color=%237289DA&logoColor=white)](https://discord.gg/2B963hn)
[![License](https://img.shields.io/github/license/python-discord/bot)](LICENSE)
[![Website](https://img.shields.io/badge/website-visit-brightgreen)](https://pythondiscord.com)

Welcome to the sixth Python Discord Code Jam!
### Welcome to the sixth Python Discord Code Jam!

By popular choice, the theme for this code jam is **Ancient Technology**. What you do with this theme or how you interpret it is up to you, but we're sure you can come up with something fun. As the technlogy for this code jam, we've chosen for [Kivy](https://kivy.org/), a cross-platform framework for making user interfaces. We know that a lot of you are probably relatively new to this framework and that's why some of Kivy's [core developers](https://kivy.org/#aboutus) will be hanging out in the #winter-code-jam channel!
#### By popular choice, the theme for this code jam is **Ancient Technology**.

What you do with this theme or how you interpret it is up to you, but it will be your task to come up with something fun using this theme.

#### The chosen technology for this code jam is [Kivy](https://kivy.org/).

Kivy is a cross-platform framework for making user interfaces. We know that a lot of you are probably relatively new to this framework and that's why some of Kivy's [core developers](https://kivy.org/#aboutus) will be hanging out in the **`#winter-code-jam`** channel to help you!

## Getting Started

1. Have your team leader fork the repository. If your leader is unavailable, it's okay if someone else does it.
### 1. Fork this repository
Have your team leader [fork](https://github.com/python-discord/code-jam-6/fork) the repository. If your leader is unavailable, it's okay if someone else does it.

### 2. Create a pull request
Open a pull request from your fork's `master` to the `master` branch of this repository. This pull requests will eventually count as your team's submission, but make sure to **open the PR when the code jam starts**. You can use the name of your team as the name of the pull request.

### 3. Keep changes to your team folder
Your own team's project files should be contained **within your own team's subdirectory**. A directory with your team's name will already exist, so make sure to use this.

### 4. Consider your development workflow
Since you are making a pull request from the `master` of your fork, it would probably be best to use different branches in your repository to work on your project. You can then periodically merge those development branches into the `master` branch.

For an ideal developer workflow, you should probably be opening pull requests inside of your fork, targeting your own `master` branch. If this doesn't make any sense to you because you're not that well-versed in git, you will probably be okay with all of you just pushing code directly to your master branch, but keep in mind that this may lead to conflicts if you are all working in parallel.

### 5. Commit to your master branch
The Pull Request you created originally will be automatically updated whenever you push code to `master` on your fork, so no need for updating anything yourself or creating a new Pull Request at the end. Just keep pushing code to your `master` branch and do your best to finish before the code jam ends!

## Important Considerations

### [The Rules](https://pythondiscord.com/pages/code-jams/code-jam-6/rules/)
Read these before starting any work on your projects.

### Documentation
Your team folder should already contain a `README.md` file that you should use to document your project. At the very least, make sure to include information on how to set up and run your project so the judges won't have trouble running it. Failure to provide this information may lead to losing points, or in extreme cases, disqualification.

### Code Style

We expect you to submit code that has a style that is in accordance with [PEP8](https://www.python.org/dev/peps/pep-0008/).

Pull requests to this repository will be **automatically linted with a tool called [flake8](http://flake8.pycqa.org/en/stable/)** ([see below](#automatic-linting-of-pull-requests) for more information). Your team folder contains a flake8 configuration file, `.flake8`, that allows you to run flake8 with the same settings as we will use.

We have set a **maximum line length of 100 characters**. This is also set and checked in the flake8 configuration.

If you wish to use an autoformatter like `black`, that is absolutely fine. Do note that most autoformatters do not guarantee that your code will pass `flake8` and it's up to you to double check that.

### Dependancy Management
You may use any third party package that's available on [PyPI](https://pypi.org/), but you should provide some form of method to easily install your project dependancies, such as a strictly pinned `requirements.txt`, a Pipfile, or some other form of dependency management list.

### Restrict Files to Team Folder
You should **make no changes outside of your team's folder**. This means that all of the files you want to include, including your code, assets and dependancy management files should all be contained that directory and not in the root level of the repository.

This ensures that we can merge your pull request into the repository once the Code Jam is over, you get GitHub contribution credit towards our organization and, most importantly, it will showcase your project on GitHub.

## Code Style and Readability

Code style and readability will be important factors in judging your team's project. We expect you to follow the style recommendations made in [PEP8](https://www.python.org/dev/peps/pep-0008/) and, to check for compliance with PEP8, we will use a linting tool called [flake8](http://flake8.pycqa.org/en/stable/). In case PEP8 and flake8 disagree, the output of the linter will be leading.

We will be using flake8 without additional plugins and with most of default settings enabled. The most notable exception is that we've set the maximum line length to 100 characters. To make it easy for you to run flake8 with the same settings as we will use, we have added a `.flake8` configuration file to your team folder.

Obviously, adhering to PEP8 is not the only factor that determines if your code is readable, so make sure to look [beyond PEP8](https://www.youtube.com/watch?v=wf-BqAjZb8M) as well.

#### Automatic Linting of Pull Requests

To help us check your code for compliance with PEP8, we have set up an automated build pipeline that will lint all pull requests made to this repository. Each time a pull requests is opened or when changes are made to the source branch (`master` on your team's fork) of a PR, the build pipeline will automatically lint the pull request. When the build process has completed, the build status will automatically be reported in the pull request:

![Failing build status](https://raw.githubusercontent.com/python-discord/code-jam-6/master/failing_build.png?token=AH7WUVAZRU56A6RY2KPVUOS6EWJUU)

Please note that **you should not use this pipeline as a remote linter**. Ideally, all changes made to the `master` branch of your team's repository have already been linted locally before they were pushed to the remote repository.

## Useful Information for Participants

Our website contains some pages that may help you get started:

2. Open a pull request from your fork's `master` to the `master` branch of this repository. This pull requests will eventually count as your team's submission, but make sure **to open the PR as the code jam starts**.
- [How to use git](https://pythondiscord.com/pages/code-jams/using-git/)

3. Make sure to **only make changes within your team's subdirectory**. The repository should already contain a directory with your team's name as the name.
- [Making a fork, opening a pull request, & creating a GitHub webhook](https://pythondiscord.com/pages/code-jams/pull-request/)

4. Since you are making a pull request from the `master` of your fork, it would probably be best to use different branches in your repository to work on your project. You can then periodically merge those development branches into the `master` branch.
- [How does judging work?](https://pythondiscord.com/pages/code-jams/judging/)

For an ideal developer workflow, you should probably be opening pull requests inside of your fork, targeting your own `master` branch. If this doesn't make any sense to you because you're not that well-versed in git, you will probably be okay with all of you just pushing code directly to your master branch, but keep in mind that this may lead to conflicts if you are all working in parallel.
## Partners and Sponsors

5. The Pull Request will be automatically updated whenever you push code to master on your fork, so all you have to do is keep pushing code to it and make sure you are finished before the code jam ends!
[![kivy_143x80](https://user-images.githubusercontent.com/33516116/72271607-173d4980-361f-11ea-8597-4140d98321f5.png)](https://kivy.org/#home) [![jetbrains_143x80](https://user-images.githubusercontent.com/33516116/72271609-173d4980-361f-11ea-8453-c996d33a649b.png)](https://www.jetbrains.com/) [![do_210x80](https://user-images.githubusercontent.com/33516116/72271610-173d4980-361f-11ea-9f3a-0e8de2b8abd1.png)](https://www.digitalocean.com/) [![linode_202x80](https://user-images.githubusercontent.com/33516116/72271608-173d4980-361f-11ea-82bf-e857efca09df.png)](https://www.linode.com/)
3 changes: 3 additions & 0 deletions amphibian-alchemists/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
2 changes: 1 addition & 1 deletion azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ jobs:
- script: pip install flake8
displayName: 'Install flake8'

- script: flake8 --exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox --ignore=E226 --max-line-length=100
- script: flake8 --isolated --exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox --max-line-length=100
displayName: 'Lint the project with flake8'
3 changes: 3 additions & 0 deletions brilliant-builders/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions circumstantial-companions/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions deprived-detectives/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions excellent-exorcists/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
Binary file added failing_build.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions fascinating-fools/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions gutsy-gamblers/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions hormonal-hedonists/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions inquisitive-investigators/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions jurassic-journalists/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions kaleidoscopic-kings/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions litigious-liberators/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions local-flake8/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=120
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
4 changes: 4 additions & 0 deletions local-flake8/failing.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
print("hello, there")
abcdefg = 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
abcdefg = 12345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
abcdefg = 123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901
3 changes: 3 additions & 0 deletions microscopic-monks/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions next-door-nuns/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions paranormal-pioneers/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions romantic-revolutionaries/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions suspicious-samaritans/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
3 changes: 3 additions & 0 deletions tactless-tricksters/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox
18 changes: 18 additions & 0 deletions temporary.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import sys


class FooBar:
pass


try:
int("a")
except:
pass

a = 1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567

friend = "something"

print(f"hello {friend}", file=sys.stderr)
print(sys.version, file=sys.stderr)
3 changes: 3 additions & 0 deletions wandering-warriors/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length=100
exclude=.cache,.venv,.svn,CVS,.bzr,.hg,.git,__pycache__,.tox