Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Visual Package Structure in docs #235

Merged
merged 1 commit into from
Nov 22, 2021
Merged

Visual Package Structure in docs #235

merged 1 commit into from
Nov 22, 2021

Conversation

AlexEidt
Copy link
Contributor

Updated the package_structure.md file to show a visual representation of all directories in the nba_api project.

Copy link
Collaborator

@rsforbes rsforbes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome. We should figure out how to make this a part of the build to keep it always current.

@rsforbes rsforbes merged commit 4805999 into swar:master Nov 22, 2021
@AlexEidt
Copy link
Contributor Author

The script is located here: https://github.com/AlexEidt/Directory-Grapher.
It uses GraphViz for the visualization, however it can also use an online API (quickchart.io) to render the graph and then save to a file from the response. That way the GraphViz binaries won't need to be downloaded. Creating the graph should just be a matter of running that script on the nba_api directory from the outside as shown below.

dir.py // Script to create graph. Must be outside of project directory.
nba_api // Project folder.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants