Introduce a style guide

[ianakotey]

Description

The codebase currently lacks a documented style guide and consistent formatting/linting configuration. This can lead to inconsistent code when others want to make changes, and can create useless maintenance work if people have different formatters that just rearrange code due to individual preferences.

Proposal

• Add a style guide (e.g., based on PEP 8) to the repository.
• Configure automated formatting tools (such as Black or isort) and linters (such as Flake8 or pylint) to enforce consistency.
• Document the configuration and usage in the README.

Recommendation:

• Update the master branch with some linting and formatting rules to ensure consistency among contributors.
  Use a pyproject.toml file to centralize and manage tool configurations for formatting and linting.

---

Example tools to consider:

• ruff (fast Python linter & formatter)
• Black
• isort
• Flake8
• pylint

[rowdyrotifer]

This project has been entirely inactive as far as contributions go for 6 years.

So while, yes, a standard linter sounds like a good idea for contribution, it sounds like there is nothing to be gained unless someone is actually doing something with the project.

[ianakotey]

Hello there. Thank you for taking time to reply, and thank you so much for this project.

I discovered the project a year ago and love using it, but it breaks on current python versions, and sometimes some responses cause the application to crash (courses not having certain fields, for example). I'd like to propose some fixes, and I am actively working on a pull request to bum up the dependencies as a start (cmd2 seems to have some breaking changes in their API I'm working on patching).

Hence, I thought it would be best to have some consistent expectations for style ahead of any other changes.

I'm willing to also suggest a pull request for that, if it's okay with you.