https://github.com/claytonjhamilton/stackoverflow-badge

Display your stats with this unique StackOverflow Badge
https://github.com/claytonjhamilton/stackoverflow-badge

hacktoberfest

Last synced: 3 months ago
JSON representation

Display your stats with this unique StackOverflow Badge

• Host: GitHub
• URL: https://github.com/claytonjhamilton/stackoverflow-badge
• Owner: claytonjhamilton
• License: cc0-1.0
• Created: 2020-12-04T03:07:50.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-10-17T23:49:43.000Z (about 1 year ago)
• Last Synced: 2024-07-31T23:46:43.549Z (5 months ago)
• Topics: hacktoberfest
• Language: Python
• Homepage:
• Size: 58.6 KB
• Stars: 22
• Watchers: 1
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-profile - StackOverflow Stats Badge - Display your stats with this Unique StackOverflow Badge! (Tools)
• fucking-awesome-github-profile-readme - StackOverflow Stats Badge - Display your stats with this Unique StackOverflow Badge! (Tools)
• awesome-readme-tools - StackOverflow Badge - Display your stats with this unique StackOverflow badge. (Badges)
• awesome-github-profile-readme - StackOverflow Stats Badge - Display your stats with this Unique StackOverflow Badge! (Tools)
• awesome-ubc-profile-readme - StackOverflow Stats Badge - Display your stats with this Unique StackOverflow Badge! (Tools)
• awesome-github-profile - Stackoverflow Badge

README

        
[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

[![first-timers-only Friendly](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](http://www.firsttimersonly.com/)

![example workflow](https://github.com/claytonjhamilton/stackoverflow-badge/actions/workflows/python-tests-action.yml/badge.svg)

[![Flake8 Status](./reports/report_badges/flake8-badge.svg?dummy=8484744)](./reports/flake8/index.html)

Display your stats with this unique StackOverflow Badge







Why

This repository is my experiment with setting up an API from scratch and serving data to end users. Along the way I was able to learn how to use GitHub Actions, write simple Python tests, and improve my understanding of FastAPI.

How to use

Update the following to include your StackOverflow UserID and embed in your GitHub profile's README or other markdown document:


```

[![HamiltonPharmD StackOverflow](https://stackoverflow-badge.onrender.com/api/StackOverflowBadge/14122375)](https://stackoverflow.com/users/14122375/hamiltonpharmd)

```

Setting up your local environment to contribute


1. Find an issue you're interested in resolving

2. Fork and clone this repo

3. Create a virtual environment

4. Run `pip install -r requirements.txt`

5. Complete code edits

6. To start the app run `uvicorn main:api`

7. Open this address in your browser to view the badge: http://127.0.0.1:8000/api/StackOverflowBadge/14122375

8. Run tests using from project root dir `python -m pytest tests/` and ensure all pass

9. Update flake8 badge `genbadge flake8 --output-file ./reports/report_badges/flake8-badge.svg`

10. Submit changes as a PR