Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,11 @@ htmlcov/
.coverage.*
*,cover

# PyEnv
.python-version

# Python VEnv
*venv*/

# Vim
*.swp
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,43 @@
# hockey-info
---
An app written in Python utilizing Flask and the NHL API to present hockey data
in a simple and easy to view manner with a focus on mobile users
An app written in Python utilizing [Flask](https://flask.palletsprojects.com/)
and the NHL API to present hockey data in a simple and easy to view manner with
a focus on mobile users


# Disclaimer
---
I do this for fun, there is absolutely no warranty or guarantee with any of this.
I don't have rights to anything the NHL does, just another hockey nerd that knows
a few neat programming tricks trying to help others absolutely


# Python Virtual Env Setup (venv)
---
It is best practice to setup an isolated Python3 "virtual environment" for any
project. Many IDEs may do this for you, automatically. However, if you need to
do this yourself, this is the basic method:

python3 -m venv venv-hockey
. ./venv-hockey/bin/activate
pip install pip setuptools wheel --upgrade
pip install -r requirements.txt

You can then work within this project without affecting other Python envs, or
your system installation. Once you are done, you should be sure to deactivate
the environment.

deactivate


# How to run it?
---
```
export FLASK_APP=app.py
flask run
```
It will start a server running on localhost and accessible on port 5000 (http://127.0.0.1:5000/)
q

If you need to run it on a different port invoke flask thusly

```
Expand Down