Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wlamason/github-stars
⭐Create a searchable view of your github stars. Runs daily with github actions.
https://github.com/wlamason/github-stars
Last synced: 17 days ago
JSON representation
⭐Create a searchable view of your github stars. Runs daily with github actions.
- Host: GitHub
- URL: https://github.com/wlamason/github-stars
- Owner: wlamason
- License: apache-2.0
- Created: 2022-03-16T02:19:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T03:41:14.000Z (about 1 month ago)
- Last Synced: 2024-10-30T06:25:28.446Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 2.87 MB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - wlamason/github-stars - ⭐Create a searchable view of your github stars. Runs daily with github actions. (Python)
README
# github-stars
[](https://github.com/wlamason/github-stars/blob/main/LICENSE)
> ⭐Create a searchable view of your github stars. Runs daily with github actions.
[Click here for an example.](https://github.com/wlamason/github-stars/blob/main/stars.md)
## Basic Usage
```
python3 github_stars.py
```
## Additional Options
```
python3 github_stars.py --help
usage: github_stars.py [-h] [-v] [-f FILENAME] [-j] [-jf JSON_FILENAME] username
Create markdown file showcasing a user's github stars.
positional arguments:
username User to extract stars from.
optional arguments:
-h, --help show this help message and exit
-v, --verbose
-f FILENAME, --filename FILENAME
Output markdown filename.
-j, --json Write json file with starred repo data.
-jf JSON_FILENAME, --json-filename JSON_FILENAME
Output json filename.
```
## Overriding Default Output
To override default output behavior, you can supply an `overrides.json` file. See [`overrides.json`](https://github.com/wlamason/github-stars/blob/main/overrides.json) for an example. [`overrides.template.json`](https://github.com/wlamason/github-stars/blob/main/overrides.template.json) is supplied as an empty template.
Attributes in `overrides.json`:
- `hidden_languages`: A list of programming languages to exclude from output.
- `hidden_repos`: A list of repos to exclude from output. Format is `/`.
- `overrides`: Key value pairs of repo in `/` format to object. The object contains key value pairs that override the [`Repo` class](https://github.com/wlamason/github-stars/blob/main/github_stars.py#L27-L36) in [`github_stars.py`](https://github.com/wlamason/github-stars/blob/main/github_stars.py).
## Running via Github Actions
This repo was created for personal use. As such, external usage is slightly convoluted. Feel free to raise a github issue if you would like to use this code, and I will make the github action more generic. Otherwise I recommend:
1. Fork this repo in the top right corner of the webpage
1. `git clone [email protected]:/github-stars.git`
1. `cd github-stars`
1. `cp overrides.template.json overrides.json`
1. Update `overrides.json` with any overrides
1. `git add .`
1. `git commit -m "personal github-stars"`
1. `git push`
1. On your fork, go to repository settings > Security > Secrets > Actions
1. Add the repository secret `GIT_TOKEN`
The value of `GIT_TOKEN` should be set to a personal access token. I recommend creating a new one just for this app. The access token will have to be updated each time it expires. To create a personal access token:
1. Click your user icon in the top right > Settings
1. Click Developer settings
1. Click Personal access tokens
2. Click Generate new token
## Running Locally
1. `python3 -m venv venv`
1. `. venv/bin/activate`
1. `python3 -m pip install -r requirements.txt`
1. `python3 github_stars.py --help`
## Generating New Requirements Files
1. `. venv/bin/activate`
1. `python3 -m pip install pip-tools`
1. `pip-compile -o requirements.txt pyproject.toml`
1. `pip-compile --extra dev -o dev-requirements.txt pyproject.toml`
## Author
👤 **Will Lamason**
* Website: [wmel.us](https://wmel.us)
* Github: [@wlamason](https://github.com/wlamason)
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2022 [Will Lamason](https://github.com/wlamason).
This project is [Apache--2.0](http://www.apache.org/licenses/LICENSE-2.0) licensed.
***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_