github-trends
🚀 Level up your GitHub profile readme with customizable cards including LOC statistics!
Quick Overview
The avgupta456/github-trends
repository is a Python script that retrieves and displays the current trending repositories on GitHub. It provides a simple and efficient way to stay up-to-date with the latest popular projects on the platform.
Pros
- Simplicity: The script is straightforward and easy to use, requiring minimal setup or configuration.
- Customizability: Users can customize the script to display trending repositories based on various filters, such as language, time range, and number of results.
- Cross-platform: The script can be run on multiple operating systems, including Windows, macOS, and Linux.
- Automated Execution: The script can be scheduled to run periodically, allowing users to stay informed about the latest trending repositories without manual intervention.
Cons
- Limited Functionality: The script primarily focuses on displaying trending repositories and does not provide additional features or analysis tools.
- Dependency on GitHub API: The script relies on the GitHub API, which may have rate limits or experience downtime, potentially affecting the script's reliability.
- Lack of Detailed Documentation: The repository's documentation could be more comprehensive, making it challenging for new users to understand the script's full capabilities and how to customize it.
- No Graphical User Interface (GUI): The script is command-line-based, which may not be preferred by all users who prefer a more visual interface.
Getting Started
To use the avgupta456/github-trends
script, follow these steps:
- Clone the repository to your local machine:
git clone https://github.com/avgupta456/github-trends.git
- Navigate to the project directory:
cd github-trends
- Install the required dependencies:
pip install -r requirements.txt
- Run the script to display the current trending repositories:
python github_trends.py
By default, the script will display the top 10 trending repositories for the past 7 days. You can customize the script's behavior by passing additional arguments, such as the number of results, the time range, and the programming language:
python github_trends.py --lang python --days 30 --limit 20
This will display the top 20 trending Python repositories for the past 30 days.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
GitHub Trends
SPECIAL: GitHub Wrapped
Check out your GitHub Wrapped at githubwrapped.io
!
What is GitHub Trends
GitHub Trends dives deep into the GitHub API to bring you exciting and impactful metrics about your code contributions. Generate insights on lines written by language, repository, and time. Easily embed dynamic images into your GitHub profile to share your statistics with the world. Check out some of the examples below:
Quickstart
First, visit https://api.githubtrends.io/auth/signup/public
and create an account with GitHub Trends. Then, paste this string into your Markdown content, substituting your username.
[![GitHub Trends SVG](https://api.githubtrends.io/user/svg/avgupta456/langs)](https://githubtrends.io)
And voila, you get a card like above. Keep reading to learn more!
Why GitHub Trends?
Unlike other projects which look at just your public repositories, GitHub Trends computes metrics based on your individual commits. If you commit to open-source projects, or have collaborators contribute to your own repositories, GitHub Trends will better measure your own code contributions. Through this method, GitHub Trends is the first project that allows users to surface lines of code written (LOC) by language and repository. Our web interface also allows for easier customization.
Usage
Website Workflow (Alpha)
Visit githubtrends.io to create an account and get started!
Have questions? Check out the demo!
API Workflow (Alpha)
Alternatively, you can communicate directly with the API to create and customize your cards. Read docs/API.md to learn more about the API and customizations.
FAQ
See docs/FAQ.md.
Contributing
See docs/CONTRIBUTING.md.
Acknowledgements
Much inspiration was taken from GitHub Readme Stats. If you haven't already, check it out and give it a star!
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot