Feedback

.gitignore

@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

README.md

@@ -0,0 +1,59 @@
+# Racing Info CLI
+
+A CLI program to track information about various motor racing series, such as the teams, drivers, engine manufacturers, and championship standings.
+
+Current implementation includes the Formula One 2023 Championship.
+
+## Glossary of Terms
+
+*This glossary is listed in no particular order.*
+
+#### **Formula One / Formula 1 / F1**
+An international motor racing series featuring open wheel racing. Currently, Formula One races are only street circuits or road courses. Famous Formula One drivers include Michael Schumacher, Lewis Hamilton, Max Verstappen, Fernando Alonso, and Sebastian Vettel.
+
+#### **Formula Two / Formula 2 / F2**
+A junior series of Formula One. Similar to the relationship between Minor League Baseball and Major League Baseball.
+
+#### **Formula E**
+The electric vehicle open wheel racing series governed by the FIA.
+
+#### **FIA / Fédération Internationale de l'Automobile**
+The governing body of Formula One, and other related motor-racing series like Formula Two and Formula E.
+
+#### **IndyCar**
+A series of open wheel racing based in the United States. Most race are in the United States, although drivers come from a variety of countries. The points and team structures of IndyCar are very different from the system used by Formula One. IndyCar tracks can be ovals, street circuits, or road courses.
+
+#### **Open Wheel Racing**
+A type of vehicle in which the wheels are exposed. If you've seen Cars 2, think of the Italian race-car. Open wheel racing series include Formula One and IndyCar. This is in contrast to series like Nascar, in which the cars look very similar to regular street cars.
+
+## Usage
+
+### Set up environment
+
+From the root project directory (`final_project-platt-sam`) run the following commands:
+
+    virtualenv -p python3 env
+    source env/bin/activate
+
+### Install required packages
+
+    pip3 install -r requirements.txt
+
+### Run unit tests
+
+    pytest tests
+
+All tests should pass. Please report any failed tests to the project maintainer.
+
+### Run the main program
+
+    python3 main.py
+
+## Future Versions
+
+* include Team Principals as an attribute of a Team
+* add other FIA series like Formula 2, Formula E, and WEC (World Endurance Championship)
+* differentiate between reserve/test drivers and full-time drivers
+* add support for IndyCar type series
+    * add support for calculating standings using IndyCar's points system
+    * create an abstract class for Teams, create concrete classes for IndyCar and Formula One teams