note: This project was done before github's recent update that allows us to navigate through repos
reponav is a Python package that allows you to easily navigate the contents of a GitHub repository. Given a repository name or URL, reponav will print out a tree-like structure of the repository's contents, including directories and files.
You can install reponav using pip:
pip install reponav
github
PyGithub
To use reponav, simply import the get_struct function and pass in the name or URL of the repository you want to navigate:
from reponav import get_struct
repo = 'username/repo'
# or 'https://github.com/username/repo'
get_struct(repo)
or:
import reponav
reponav.get_struct('username/repo')
# or 'https://github.com/username/repo'
get_struct will print out a tree-like structure of the repository's contents to the console.
Contributions are welcome! If you find any bugs or have any suggestions for new features, please start an issue or contact the author.
If you would like to contribute code to this project, please follow these steps:
- Fork this repository.
- Create a new branch with a descriptive name (
git checkout -b my_new_feature). - Write your code and tests, ensuring that they pass.
- Push your changes to your fork (
git push origin my_new_feature). - Open a pull request and describe your changes.
Thank you for your contributions!