package starred_ml
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=82f3404fa22ca5627a50104d053139702034f3c8b59211bbc474b11f9042965a
sha512=db8210b15a5f665e0e40705665c74d021b436ec97b6072003ba54122d91d7489b3fb1f9edb30c8fb2b593914e39116ccd9dcbb196e287dd4c95da65177a4ea17
Description
Turn your starred items into a awesomeness list of repos
Published: 29 Apr 2024
README
Starred_ml - Github Awesome list based on starred proejct
Are you a compulsive Github stargazer? Starred_ml
is here for you! It will access Github https://api.github.com/user/starred
API and fetch all starred repositories and dump a mardown that you can use as README.md
in a repository.
Running
opam update
opam install starred_ml
TOKEN={{your github personal token}} starred_ml > README.md
For full option list, run starred_ml --help
.
See Templating section for details on the output markdown.
Will output something liket this:
Awesome Stars
===
> A curated list of Github stars! Generated by [starred_ml](https://github.com/paulosuzart/starred_ml)
Languages
---
- [C](#C)
- [C#](#C#)
- [C++](#C++)
- [Haskell](#Haskell)
- [Java](#Java)
- [Jupyter Notebook](#Jupyter Notebook)
- [Lua](#Lua)
...
Contents
---
## C
- [pikasTech/PikaPython](https://api.github.com/repos/pikasTech/PikaPython) - An ultra-lightweight Python interpreter that runs with only 4KB of RAM, zero dependencies. It is ready to use out of the box without any configuration required and easy to extend with C. Similar project: MicroPython, JerryScript.
## C#
- [microsoft/kiota](https://api.github.com/repos/microsoft/kiota) - OpenAPI based HTTP Client code generator
...
Generating your awesome README.md
You can run starred_ml
locally, but it makes more sense that you atomatically generate a README.md in dedicated github repository. For that you can use my Awesome as a template https://github.com/paulosuzart/awesome
.
You need two things:
Select
Allow GitHub Actions to create and approve pull requests
under (YOUR REPO)/Settings/Actions/General.A PAT Personal Access Token with starred read-only access that you must set to your awesome repository under (YOUR REPO)/Settings/Secrets and variables/Actions, then in the
Repository Secrets
you can add your generated token with the nameTOKEN
.
Templating
Starred_ml
uses jingoo as a template engine. Create a template file (default is default.jingoo
) if you want to customize. You can reuse the provided template here and customize as you see fit. You can save the template with a different name. Use --template
the specify a different template file.
The availabe variables are:
lang_count
- The total count of languages found (IncludingNot set
)languages
- a list of languages detected across all starred reposby_language
- a list of objects representing starred repositories with the following keys:language
- the language of in questionstarred
- a list of objects with the following keys:name
- name of the repositoryhtml_url
- Github urldescription
- repository descriptionowner_login
- the repository owner login
Similar projects
While developing Starred_ml
I found at least one alternative:
smaguowei/starred written in python. I then proceeded to use a similar output
Dependencies (15)
-
dune
>= "3.14"
- ocaml
-
cohttp-eio
>= "6.0.0~beta2"
-
eio
>= "1.0"
-
eio_main
>= "1.0"
-
fmt
>= "0.9.0"
-
jingoo
>= "1.5.0"
-
logs
>= "0.7.0"
-
mirage-crypto-rng-eio
>= "0.11.3" & < "1.0.0"
-
ppx_deriving
>= "5.2.1"
-
ppx_deriving_yojson
>= "3.7.0"
-
tls-eio
>= "0.17.3" & < "1.0.0"
-
yojson
>= "2.1.2"
-
re2
>= "v0.16.0"
-
cmdliner
>= "1.2.0"
Used by
None
Conflicts
None