{"id":20810555,"url":"https://github.com/devfle/readme-level-up","last_synced_at":"2025-05-07T08:43:53.852Z","repository":{"id":65106538,"uuid":"573919882","full_name":"devfle/readme-level-up","owner":"devfle","description":"A small action that converts interactions made on GitHub into experience points","archived":false,"fork":false,"pushed_at":"2024-06-03T21:39:10.000Z","size":41,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T21:37:08.958Z","etag":null,"topics":["automation","game","github-actions","github-api","portfolio","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devfle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-03T21:09:12.000Z","updated_at":"2024-06-03T21:50:06.000Z","dependencies_parsed_at":"2023-10-11T21:52:23.031Z","dependency_job_id":"ae5a6a45-eb04-4dbe-a16f-b33d071f7d15","html_url":"https://github.com/devfle/readme-level-up","commit_stats":{"total_commits":22,"total_committers":1,"mean_commits":22.0,"dds":0.0,"last_synced_commit":"8479e4bdad8c55be78fa241892c05c4a9b2eddf8"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devfle%2Freadme-level-up","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devfle%2Freadme-level-up/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devfle%2Freadme-level-up/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devfle%2Freadme-level-up/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devfle","download_url":"https://codeload.github.com/devfle/readme-level-up/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252846105,"owners_count":21813378,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","game","github-actions","github-api","portfolio","python"],"created_at":"2024-11-17T20:25:59.387Z","updated_at":"2025-05-07T08:43:53.832Z","avatar_url":"https://github.com/devfle.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Read Me Level Up\n\nReadme level up is a small action that converts interactions made on GitHub into experience points. If you have enough experience points your level increases. The action suits perfectly for the profile page on Github.\n\n\u003cimg width=\"65%\" alt=\"01\" src=\"https://user-images.githubusercontent.com/52854338/213002429-c5cd4fa6-8342-4af9-8b28-40c1ac941b60.png\"\u003e\n\n# Setup Action\n\nI explain here how to set up the action. The Github profile readme serves as an example. But any other readme can be used as well.\n\n1. Add the following comments to your readme file:\n\n```text\n\u003c!--README_LEVEL_UP:START--\u003e\n\u003c!--README_LEVEL_UP:END--\u003e\n```\n\n2. create a new workflow with the following example content.\n\n# Example Action Setup\n\n```yml\nname: Update Readme Level\non:\n  workflow_dispatch:\n  schedule:\n    - cron: '0 08 * * *'\njobs:\n  update-readme:\n    runs-on: ubuntu-latest\n    steps:\n      - name: checkout project\n        uses: actions/checkout@v4\n      - name: update markdown file\n        uses: devfle/readme-level-up@main\n        with:\n          github_username: GITHUB_USERNAME\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n      - name: commit markdown file\n        run: |\n          git config --local user.email \"github-actions[bot]@users.noreply.github.com\"\n          git config --local user.name \"github-actions[bot]\"\n          git commit --allow-empty -am \"update readme\"\n      - name: push changes\n        uses: ad-m/github-push-action@master\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          branch: main\n```\n\n# Environment Variables\n\nAll available environment variables and their default values can be found in the [action.yml file.](../main/action.yml)\n\n# Todos\n\nI started the project because I had a fun idea and wanted to learn Python. Some things still need to be done:\n\n- add types to all vars\n- add error management\n- add more data to level calculation\n- add more options as env vars\n- and more...\n\nIf you have any ideas about what could be optimized, feel free to create an issue.\n\n# Contribution Guide\n\nI appreciate any support with this project. If you have a suggestion for improvement or found a bug, please create a new issue. Please make sure that there is not already an existing issue for your request.\n\n- This project uses the conventional [commits specification.](https://www.conventionalcommits.org/en/v1.0.0/#specification)\n- Currently Python 3.11 is used.\n- For development, we recommend the usage of the VS-Code Python linter from Microsoft (Pylance).\n- Please test your changes before opening a new merge request.\n\nYou have to install some packages before starting to develop:\n\n```bash\npip install -r requirements.txt\n```\n\nTo start the script, you have to call:\n\n```bash\npython main.py\n```\n\nPlease follow these coding guidelines:\n\n```python\n# var names in snake_case\nvar_name: int = 1\n\n# function names in snake_case\ndef function_name -\u003e None:\n    pass\n\n# const names in uppercase\nCONSTANT_NAME: int = 1\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevfle%2Freadme-level-up","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevfle%2Freadme-level-up","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevfle%2Freadme-level-up/lists"}