Python project to manage and keep the github profile content up to date and alive, though these Python classes are more capable than just manipulate a readme file.
The purpose of this project is to update the readme.md file of the github profile
with data from the user's github activities, wakatime information and links to RSS feed urls (if provided).
The GithubAdmin class could be a powerful github management program
هf it can get the required functions and permissions that such a program needs,
but this project was not about this idea.
The access to user's gists on github is provided by github Personal access token,
so requires no additional configuration.
-
A github Personal access token with at least
repoanduserscopes checked. -
Optional: If you have or want to access WakaTime account info, a
Secret API Keyfrom your account settings. -
In the
Settingsof your profile repository from the left side menu click onSecrets, then clickNew repository secret, name itGH_TOKENand for the Value enter yourPersonal access token. -
For WakaTime Secret API Key do the same, just name it
WAKA_TIME_TOKEN.
in your repository create a .yml file (no matter the name), in side .github/workflows
directory, write the following code down inside of it*:
name: github-profile-admin # Optional - The name of the workflow as it will appear in the Actions tab of the GitHub repository.
on:
schedule: # Run workflow automatically
- cron: '0 */6 * * *' # This means every sixth hour starting from 0, i.e. at hour 0, 6, 12 and 18
workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the Github Actions Workflow page directly
jobs: # Groups together all the jobs that run in the yml workflow file.
build:
runs-on: ubuntu-latest
steps:
- name: checkout repo content
uses: actions/checkout@v2 # checkout the repository content to github runner
- name: setup python
uses: actions/setup-python@v2
with:
python-version: '3.9.5' # install the python version needed
- name: install python packages
# Using `run: |`, we run multi line python code in the runner.
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: execute py script # run main.py
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
WAKA_TIME_TOKEN: ${{ secrets.WAKA_TIME_TOKEN }}
GISTS_TAG: '<!-- GISTS:START -->,<!-- GISTS:END -->' # the same comment tags must be in the readme.md
run: python main.pycode guid canovasjm.netlify.app. ↩