https://github.com/computingvictor/kaggle_badge

Obtain your own personalised Kaggle profile card
https://github.com/computingvictor/kaggle_badge

badge docker githubactions kaggle open-source readme-profile

Last synced: 1 day ago
JSON representation

Obtain your own personalised Kaggle profile card

• Host: GitHub
• URL: https://github.com/computingvictor/kaggle_badge
• Owner: ComputingVictor
• License: apache-2.0
• Created: 2024-03-15T20:31:57.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-04-16T15:03:41.000Z (7 months ago)
• Last Synced: 2024-04-16T21:15:00.873Z (7 months ago)
• Topics: badge, docker, githubactions, kaggle, open-source, readme-profile
• Language: Jupyter Notebook
• Homepage:
• Size: 4.84 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kaggle_Badge



  



## Description

`Kaggle_Badge` is a project designed to create customizable badges showcasing Kaggle user profiles and data. It employs Selenium to scrape profile information directly from the Kaggle website and generates a badge based on a pre-defined template. This project uses GitHub Actions to automate the entire process, including setting up the Docker environment, so there's no need to have Docker installed on your local system.

## Technologies

- **GitHub Actions**: Automates the data extraction and badge generation process within a Docker container, requiring no local Docker installation.

- **Selenium**: For navigating the Kaggle page and extracting required data.

## Usage

To use this project, follow these steps:

1. Fork the repository to your own GitHub account.

2. Go to the Actions tab in your forked repository.

3. Modify the workflow file to include your Kaggle username and desired cache settings.

4. GitHub Actions will handle the rest, executing within Docker automatically, and creating a compressed image artifact of the badge.

## Contributing

`Kaggle_Badge` is an open community project. The project is in its early stages, with many areas for improvement, particularly in badge design and functionality expansion. If you have ideas or contributions, you are encouraged to participate. You can do so in the following ways:

- **Fork** the repository and clone your fork locally.

- Create a new **branch** for your changes.

- Implement your features or improvements.

- Submit a **pull request** to merge your changes back into the main project.

## License

This project is licensed under APACHE 2.0 , allowing others to use, modify, and distribute the project in various ways. Please see the `LICENSE` file for more details.

## Acknowledgments

We appreciate everyone who contributes to improving this project and look forward to building a useful tool for the community with your help.

---

### Note

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Kaggle.com, or any of its subsidiaries or affiliates.