dangkv / iracing_garage Goto Github PK

What makes a good README.md?

For users:

• How to install package
• How to get started
• What are the available methods to use

For contributors:

• What are the code standards?
  • how to deploy
• How to setup environment to contribute

I want Mkdocs to host iracing_garage documentations in ./docs.
Configure MkDocs so that it is hosting the methods file.
No need to worry about the theme yet.

Resources:

• Inspiration: https://esterni.github.io/pyracing/
• https://www.mkdocs.org/getting-started/
• https://www.youtube.com/watch?v=Q-YA_dA8C20

Goal

The objective of this issue is to create a CI (Continuous Integration) to force Python Black and pep8 standards to our code base. Black is a python package that automatically for formats your python code. Flake8 is a package that highlights Python code that doesn't follow pep8 standards. This allows the code to be readable, maintainable, and efficient.

Objective

• On commits, I want the automation pep8 and black to run
• I want a github action to validate if the code is up to standards before being implemented into production

Steps

• install pre-commits
• install black and flake8 modele in pre-commits
• configure pre-commits rules
• configure black and flake8 rules

Resources

• https://www.youtube.com/watch?v=XFyLzr5Ehf0
• https://black.readthedocs.io/en/stable/integrations/github_actions.html
• https://github.com/marketplace/actions/run-black-formatter

Objective:

Create a script that extracts the iRacing endpoint parameters and save it in a formatted markdown file.

You can find all the metadata in this json file: api.json

Acceptance Criteria:

• One md file for all the methods and arguments
• The python script itself does not need to be In the package, just the formatted md files
• Save the file under ./docs as methods.md

The format of the markdown:

### car.assets()

image paths are relative to https://images-static.iracing.com/

link:`https://members-ng.iracing.com/data/car/assets`

---

### car.get()

link: `https://members-ng.iracing.com/data/car/get`

---

### carclass.get()

link: `https://members-ng.iracing.com/data/carclass/get`

---

### hosted.combined_sessions()

Sessions that can be joined as a driver or spectator, and also includes non-league pending sessions for the user.

| Argument   | Data Type | Description                                                      | Required |
|------------|-----------|------------------------------------------------------------------|----------|
| package_id | number    | If set, return only sessions using this car or track package ID. | False    |

link: `https://members-ng.iracing.com/data/hosted/combined_sessions`

Goal:

To configure Github in a way to help the iRacing community extract API data. Github stars help make the package more popular.

Brief topics to look into

• What GitHub repo settings do we need to configure so that others can contribute to the project?
• Security Settings?
• What are Insights / Community Standards?
• Issue Templates
• PR Templates

Useful Links:

1. https://contributing.md/
2. https://opensource.guide/starting-a-project/
3. https://www.youtube.com/watch?v=eNDuqcrLTLs
4. https://www.youtube.com/watch?v=1wKtKFY_ueM

Resources:

• https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
• https://www.youtube.com/watch?v=D_Jb52jw2HY
• https://packaging.python.org/en/latest/tutorials/packaging-projects/#a-simple-project
• https://www.youtube.com/watch?v=Kz6IlDCyOUY