π fireworks π
π Fireworks. A Python Package used for getting data from Github! Also maintained on Github! π Maintained by @SwiftyProgrammer690 on github, @SwaritChoudhari on replit.com
Getting Started! πππ
Prequisteries: pip install urllib
First, download the code and then unzip it:
or, clone this in your local engine with https://github.com/SwiftyProgrammer690/fireworks.git
!
Now that you have the necessary files to work with this project, letβs see what it does!
Using it! βββ
For the functions below to work, put them inside a print statement!
First at the beginning of your new python file, add from src.source import *
to load the files for the package! (If that does not work, please use pwd
and check where you are and ls
to know where you should go with cd
)
For now, it only has eighteen main capabilities, but you can make it better because, after all, this is an open source project!
Name(For usage) | What it does |
---|---|
get_org_repositories(org) |
Get an organizations repos |
get_user_repositories(user) |
Get an users repos |
get_user(user) |
Get a user profile |
get_org(org) |
Get an organizations profile |
get_emoji() |
Gets all the available github emojis and images |
get_repo_branches(user, repo) |
Gets all the branches of a repository |
get_org_projects(org) |
Get organizations projects |
get_repo_pulls(user, repo) |
Get a repos pulls requests |
get_public_gists() |
Get the public gists |
get_gist(gist_id) |
Get a specific gist |
get_user_gists(user) |
Get a users gists |
zen() |
Get a random quote from githubβs API |
octocat() |
Get a random quote from githubβs octocat! |
check_repo_health(user, repo) |
Get a repos health(Does it have⦠README, Licence, Code of conduct, Contributing guidelines?) |
check_repo_lang(user, repo) |
Get a repositories languages |
check_repo_tag(user, repo) |
Get a repositories tags |
check_repo_topic(user, repo) |
Get a repositories topics |
get_public_repo() |
Gets a list of random public repositories |
Once you are done writing your program, make sure to run it! ;)
Contributing! π€π€π€
We would love the extra support! Feel free to open a pull request! To start contributing to this repo, keep in mind, the main code is in the src/source.py and I will create an alike pull request to yours so I can update the pycache Also read the CONTRIBUTING.md page!
Compare:
Support
If you run into any problems, please open an issue on github and I will get back to you as soon as I can!
Licence
Released under MIT by @SwiftyProgrammer690.
Contributors β¨
Thanks goes to these wonderful people (emoji key):
Mousie! π¨ |
Swarit Choudhari π» π¬ π |
All Contributors π§ |
code code code! π |
This project follows the all-contributors specification. Contributions of any kind welcome!