NFL Big Data Bowl 2023
Common Commands
| Command | Description |
|---|---|
pytest |
Run all unit tests. |
run jupyter |
Start a Jupyter notebook server (automatically launched). |
run install-python-requirements |
Install the latest Python requirements to your virtual environment. |
git checkout -b branch_name |
Create a new branch named branch_name. |
git status |
Check which files have been modified or added. |
git add . |
Add all changes. |
pre-commit run |
Run pre-commit on added changes. |
git commit -m "message" |
Create a commit with a message and run pre-commit. |
git push |
Push changes to remote. |
Setup Instructions
- Accept the GitHub invitation granting you read and write access to this repository
- Login to GitPod using the same GitHub account
-
Login to Kaggle and get your Kaggle credentials
- Click on your profile picture in the top right corner and go to the "Your Profile" page
- Click the "Account" tab
- Scroll down to the "API" section
- Click the "Create New API Token" button, which will trigger a download
- Save the file to your computer
- Open the file in a text editor to view your username and secret key
- Go back to GitPod to save your Kaggle credentials
- Open the environment variables page
- Click the "New Variable" button
- Create a new variable for your Kaggle username:
- Name:
KAGGLE_USERNAME - Value:
your_username - Scope:
vingkan/nflbigdatabowl2023
- Name:
- Create a new variable for your Kaggle key:
- Name:
KAGGLE_KEY - Value:
your_key - Scope:
vingkan/nflbigdatabowl2023
- Name:
- Go to the GitHub repository page and click the GitPod button at the top of the README to start up a workspace
- Automatic setup commands will run on GitPod and then you can use the terminal an editor freely
Release Process
To publish new versions to PyPi (reference):
# Increment the version number in pyproject.toml
# Build package
rm -rf dist
python3 -m build
# Upload to Test PyPi
python3 -m twine upload --repository testpypi dist/*
python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps nflpocketarea2023
# Upload to PyPi
python3 -m twine upload dist/*
python3 -m pip install --no-deps nflpocketarea2023
