user-statistician
awesome-readme
Our great sponsors
user-statistician | awesome-readme | |
---|---|---|
18 | 30 | |
74 | 16,912 | |
- | - | |
7.8 | 6.4 | |
7 days ago | 6 days ago | |
Python | ||
MIT License | - |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
user-statistician
-
Hacktoberfest 2023 Update from Maintainer of the user-statistician GitHub Action
The cicirello/user-statistician GitHub Action generates a detailed visual summary of your activity on GitHub in the form of an SVG suitable to display on your GitHub Profile README Although the intended use-case is to generate an SVG image for your GitHub Profile README you can also potentially link to the image from a personal website, or from anywhere else where you'd like to share a summary of your activity on GitHub. The SVG that the action generates includes statistics for the repositories that you own, your contribution statistics (e.g., commits, issues, PRs, etc), as well as the distribution of languages within public repositories that you own The user stats image can be customized, including the colors such as with one of the built-in themes or your own set of custom…
-
Hacktoberfest 2023 Contributors Wanted: Additional Translations for the user-statistician GitHub Action
Contributing a language translation mostly involves creating a new JSON file named with the ISO 639-1 two-character code for the language, or for languages that don't have a two-character code, the ISO 639-2 three-character language code. Then within that JSON file, translating all of the string values. You also need to add the locale code to a Python set of supported locales within src/StatConfig.py.
-
Automate Updating Major Release Tag on New Releases of a GitHub Action
I maintain several GitHub Actions, such as jacoco-badge-generator, generate-sitemap, javadoc-cleanup, and user-statistician. I've also written posts here on DEV about each of these if you'd like more information. GitHub's documentation for GitHub Action developers recommends maintaining a major release tag for the Action so that users can either reference the Action by its specific release tag, such as v1.2.3, or simply by the major release with v1. In fact, it is so commonplace that users will likely assume that your Action supports specifying full version tag or major tag only. Note that some Actions use major release branches (e.g., branch named v1) instead of tags. My intention in this post is not to discuss the advantages/disadvantages of each of these alternative approaches. In the Actions that I maintain, I use major release tags for the simple reason that it is what GitHub's documentation recommends.
-
Bonus Tip: How to Use GitHub Actions to Test a GitHub Action Whose Output Must be Visually Inspected
The complete workflow for this project is found at: build.yml. The repository itself is:
-
How to Patch the Deprecated set-output in GitHub Workflows and in Container Actions
I use GitHub Actions to automate a variety of things in nearly all of my repositories, such as running a build and tests during pull-requests and pushes, deploying artifacts to Maven Central, etc for my Java libraries, or to PyPI for a couple Python projects, building my personal website with my custom static site generator, among a variety of other tasks. In addition to using GitHub Actions for workflow automation, I also develop and maintain a few Actions (all implemented in Python), including jacoco-badge-generator, user-statistician, javadoc-cleanup, and generate-sitemap.
-
How to Use Maven Profiles to Selectively Activate Plugins and Other Configuration from the Command Line
If you want to generate the equivalent to the above for your own GitHub profile, check out the cicirello/user-statistician GitHub Action.
-
Hacktoberfest Progress Update: Translation Contributions Still Welcome
The cicirello/user-statistician GitHub Action generates a detailed visual summary of your activity on GitHub in the form of an SVG suitable to display on your GitHub Profile README Although the intended use-case is to generate an SVG image for your GitHub Profile README you can also potentially link to the image from a personal website, or from anywhere else where you'd like to share a summary of your activity on GitHub. The SVG that the action generates includes statistics for the repositories that you own, your contribution…
-
Hacktoberfest Language Translation Contributors Wanted for the user-statistician GitHub Action
The user-statistician GitHub Action is implemented in Python as a container action. You don't need to know any Docker to contribute, as you won't need to touch the Dockerfile, and the unit tests can run locally with Python alone (the unit tests don't actually query the GitHub API, instead using fake query results). If you know how to add elements to a Python dictionary, then your Python background is sufficient. There is a single Python file that you would need to edit: StatConfig.py. There is a comment within that has an itemized list of what is required to contribute a language translation, and mostly involves adding your translation of the various headings and labels, as well as a translation of the title template, to a couple of Python dictionaries, and adding the language code to a Python set.
-
Halloween Themes for the user-statistician GitHub Action
Just in time for Halloween, and Hacktoberfest, I recently added a few Halloween themes to the user-statistician GitHub Action. I've posted about the user-statistician GitHub Action before. It generates an SVG with a detailed summary of your activity on GitHub suitable for inclusion in your GitHub Profile README or on a personal website. The intended use-case is to run on a schedule via a GitHub workflow in your GitHub Profile repository (repository with same name as your username). It is implemented in Python as a Container Action, and uses the GitHub CLI to query the GitHub GraphQL API to gather the data. For a more detailed summary of its functionality, see my earlier DEV post as well as other posts in this series:
-
Configuring GitHub's Linguist to Improve Repository Language Reporting
In this post, I explain how to configure GitHub's Linguist within your repository to enable more accurate and more relevant repository language reporting, with examples from a few of my own repositories. Every repository on GitHub has a chart that shows the distribution of languages detected in the repository. GitHub's Linguist is responsible for detecting the language of each file within your repository, and the reported percentages are based on file sizes. For example, "Java 50%" means that 50% of the total size of all detected files in the repository are Java files. There are also third party tools that display language statistics, such as the user-statistician GitHub Action that I developed and maintain, which includes on an SVG (among other things) a pie chart summarizing the language distribution across all of your public repositories (excluding forks). The language data necessary to generate that language chart comes from GitHub's GraphQL API, which is as it is reported for each of your repositories by Linguist.
awesome-readme
- Readme: A Curated List of READMEs
- Awesome Readme: A Curated List of READMEs
-
Hacktoberfest 2023 Update from Maintainer of the user-statistician GitHub Action
About user-statistician
-
Hacktoberfest 2023 Contributors Wanted: Additional Translations for the user-statistician GitHub Action
The user-statistician GitHub Action can generate an SVG with a detailed summary of your activity on GitHub. It is mentioned in the tools section of the awesome README awesome list. The SVG it generates includes general information about you (e.g., year you joined, number of followers, number you are following, most starred repository, etc), information about your repositories (e.g., numbers of stars and forks, etc), information about your contributions (e.g., numbers of commits, issues, PRs, etc), and the distribution of languages within your public repositories.
- Mastering Readme Files
-
Marketing for Developers
If you really want a stellar README.md take a look at some of the examples in awesome-readme for inspiration!
-
How to Create the Best README for Your GitHub Project
Awesome README - A collection of high-quality READMEs from a variety of projects, organized by topic. https://github.com/matiassingers/awesome-readme
-
How to create projects for myself to enrich my resume?
Provide a succinct and comprehensive README: readers of your personal project will always start with the README to know where to begin. The goal of the README is to provide the reader an understanding of the business problem you are trying to solve, how your solution goes about solving it (solution architecture diagram), and how to get started and run your code. There are plenty of great README examples here: https://github.com/matiassingers/awesome-readme
-
Configuring GitHub's Linguist to Improve Repository Language Reporting
About user-statistician
-
The user-statistician GitHub Action mentioned in Awesome-README
Recently, the user-statistician GitHub Action was added to the tools section of Awesome README, which is an Awesome List that includes a curated collection of examples of Awesome READMEs from open source projects, as well as tools enabling creating Awesome READMEs. The Awesome README list is a great place to go if you are looking for ideas for how to improve the READMEs of your open source projects. The Awesome README list covers READMEs more generally, but the tools section includes a few tools focused on Profile READMEs, in addition to many tools for project READMEs more generally. The user-statistician GitHub Action is in the Tools Section.
What are some alternatives?
quote-readme - A GitHub Action that allows you to place a random quote/fun-fact on your README file, from a collection of famous computer science quotes/facts !
revo-grid - Powerful virtual data grid smartsheet with advanced customization. Best features from excel plus incredible performance 🔋
hacktoberfest-webpage - Let's build a website for #Hacktoberfest - This is a really simple Progressive Web Site built using Lit. Contribute what you can to build on this start and turn it into a beautiful website.
Konva - Konva.js is an HTML5 Canvas JavaScript framework that extends the 2d context by enabling canvas interactivity for desktop and mobile applications.
Chips-n-Salsa - A Java library of Customizable, Hybridizable, Iterative, Parallel, Stochastic, and Self-Adaptive Local Search Algorithms
Apache AGE - Graph database optimized for fast analysis and real-time data processing. It is provided as an extension to PostgreSQL. [Moved to: https://github.com/apache/age]
github-contribution-graph - Add beautiful GitHub contribution/commit graph to your profile README!
amplify-cli - The AWS Amplify CLI is a toolchain for simplifying serverless web and mobile development.
generate-sitemap - Generate an XML sitemap for a GitHub Pages site using GitHub Actions
spring-rest-crud-example - Use this repository as a basis to start the development of a new Java REST API.
website-v2 - Nuxt 2 Documentation Website
minio-py - MinIO Client SDK for Python