sudiptob2 / cf-stats

A github action based realtime Codeforces activity statistics card and badge generator for github readme

MSc @UWO, Opensource contributor in Kubernetes, Infra and DevOps.

MSc in Computer Science at the University of Western Ontario in Canada 🇨🇦. My journey into the world of open-source software began in late 2022, and I quickly fell in love with it, prompting me to consistently contribute to open-source projects ever since ❤️ I mostly contribute in Kubernetes, Infra, Observability, Cloud, and DevOps-related tools and software.

View my resume here.

OPENSOURCE EXPERIENCES

Opensource Software Engineer (Aug 2024 - Present) | Internship (May - July 2024) | G-Research OSS Project Link: https://github.com/G-Research/yunikorn-history-server

Yunikorn History Server (YHS) is a historical log management plugin for the K8s cluster that uses apache/yunikorn as the scheduler.

1. Implemented logging mechanism using zap
2. Complete Helm Chart for YHS
3. Implemented performance test using K6
4. E2E testing of the webservice and event listener modules.
5. Also worked on ci/cd, endpoint implementations, documentation, unit tests and participated in project management and peer review.
6. List of PRs: is:pr author:sudiptob2 is:merged

MLH Fellowship | Apace/Airflow Project Link: https://github.com/apache/airflow

1. Migrating to Connexion version 3
2. Enhancing logging functionality of Kubernetes Pod Operator (KPO)
3. Open PR: apache/airflow#37638

GOOGLE SUMMER OF CODE 2023 | GCP SCANNER Project Link: https://github.com/google/gcp_scanner

1. Enhanced test coverage by incorporating new unit tests, resulting in a 10% increase in overall coverage.
2. Did significant refactoring effort for the crawling module to enhance modularity and promote the ”Don’t Repeat Yourself” principle.
3. Expanding the capabilities of the application by enabling it to scan a wider range of GCP resources, thereby broadening its potential use cases.

KEPTN LIFECYCLE TOOLKIT | CNCF Project Link: https://github.com/keptn/lifecycle-toolkit

1. Contributed approximately 700 lines of code to the project while implementing new features, bug fixes, and writing unit tests in Golang.
2. Implemented Datadog metric provider integration. PR link: #948
3. Collaborated on the development and enhancement of documentation materials.

CF STATS | PERSONAL PROJECT Project Link: https://github.com/sudiptob2/cf‐stats

1. Utilized GitHub action to generate real-time Codeforces user stat card and badges for readme files.
2. Implemented Python design patterns to facilitate the consumption of Codeforces API in a scaleable manner.
3. Applied Pytest for feature-level unit testing and implemented GitHub Actions for appropriate test pipeline execution.
4. Created proper documentation and followed open-source best practices such as branch naming conventions, commit messages, issue tracking, etc.
5. Has 100+ ⭐ on the repo.

Some other notable open-source projects and contributions ChkWareCLI, LeetEasy, jx-promote etc.

Development Stuffs:

⚡ Github Stats

📈 Competitive Programming

Recent Blogs

• Scaling Kubernetes workloads using HPA + Prometheus + Keptn Metrics
• Before you start kubebuilder.io; Writing a simple custom K8s operators
• My 1-week GoLang preparation
• Properly Setting Up React Development Environment Using Docker

Connect With Me

cf-stats's Issues

Add project background in the readme

Update the readme documentation to provide a holistic background and the motivation behind this project to future users and contributors.

Problem when Run Workflow

add template svg files

To display code-forces SVG in the GitHub readme files, an SVG must be generated. To generate the stat SVG we will use some base template SVGs.

Add these base svgs under the template folder

do not ignore output folder

Output folder will be used by the CI/CD pipelines and the generated stats will be saved there.

implement codeforces API for getting user data

Rank too long (legendary grandmaster) breaks the card.

Long rank such as legendary grandmaster breaks the card 🤔
I hope a legendary grandmaster will fix this bug 🙏

Implement github actions for generating the stats and badges.

Github actions will generate all the stat images and badges. This action will run as a corn job.

implement maximum rating badge

Generate Badge with maximum rating

Total Problems Solved Add Request

Total Problems Solved Add Request

Add visualization example in the readme.

Update name slicer

There are names such as MD Abdul Rahman Talukder. These names will be converted into MD by the slicer.
We need to update the slicer so that it can slice the name in a more readable manner.

Implement proper badge color according to the users rating.

In codeforces, users are identified with different colors. ex, blue coder, red coder. This color depends on the uses rating. Codeforces bade should be rendered with the appropriate color.

Add video tutorial in Hindi language

for general instruction ref: #47

Look at this step-by-step screenshot guide to get an idea of how the tutorial should look like
step-by-step screenshot

Upload the video to your youtube channel and add the link in the project readme

Implement `member_since` attribute for the user

From the codeforces API, we can obtain the UNIX timestamp since the use joined in CF. Use this timestamp to calculate the member_since attribute.
calculate the attribute in floor(years).

After Using the instructions

Card texts breaks if the user has Long names

Implement generation of stat card

fix broken codeforces logo in the badges

The rating and max_rating badges are generated using ppybadge library. CF logo used in the badge is not rendered properly when viewed inside readme/Github.
But if you download/save the image on your local computer and then open it with any image viewer/browser the logo is visible!
We need to fix this bug/investigate why this issue is occurring.

Add minimal contribution guidelines

Updade readme with installation steps screenshots

Add a video tutorial (Any langulage) on how to use this template

I need video tutorials on how to use this template.

• sound must be clear
• No noise
• Any language accepted

Hacktoberfest participants are welcome.

Add installation instruction in the readme

Organization name should be converted into acronym

Codeforces API will return the organization name of the user. For example Patuakhali Science and Technology University
This name should be converted into PSTU

Add a workflow to run pytests when a pull request is created

change cf logo url

implement .env for configuration management

Use pydantic Blog post

bug on contributions fetching

There is a spelling mistake in the contribution key in app/services/cf_response_parser.py _parse_user_info() method.
The key will be contribution instead of contributions