PyPI 官网下载 | best-of-0.7.0.tar.gz

<!-- markdownlint-disable MD033 MD041 --> <h1 align="center"> Best-of Generator </h1> <p align="center"> <strong>🏆&nbsp; Generates a ranked markdown list of awesome libraries and tools.</strong> </p> <p align="center"> <a href="https://best-of.org" title="Best-of Badge"><img src="http://bit.ly/3o3EHNN"></a> <a href="https://pypi.org/project/best-of/" title="PyPi Version"><img src="https://img.shields.io/pypi/v/best-of?color=green&style=flat"></a> <a href="https://github.com/best-of-lists/best-of-generator/actions?query=workflow%3Abuild-pipeline" title="Build status"><img src="https://img.shields.io/github/workflow/status/best-of-lists/best-of-generator/build-pipeline?style=flat"></a> <a href="https://gitter.im/ml-tooling/best-of" title="Chat on Gitter"><img src="https://badges.gitter.im/ml-tooling/best-of.svg"></a> <a href="https://bestoflists.substack.com/subscribe" title="Subscribe for updates"><img src="http://bit.ly/2Md9rxM"></a> <a href="https://twitter.com/best_of_lists" title="Best-of on Twitter"><img src="https://img.shields.io/twitter/follow/best_of_lists.svg?style=social&label=Follow"></a> </p> <p align="center"> <a href="#getting-started">Getting Started</a> • <a href="#documentation">Documentation</a> • <a href="#support--feedback">Support</a> • <a href="https://github.com/best-of-lists/best-of-generator/issues/new?labels=bug&template=01_bug-report.md">Report a Bug</a> • <a href="#contribution">Contribution</a> • <a href="https://github.com/best-of-lists/best-of-generator/releases">Changelog</a> </p> The best-of-generator is a CLI tool to generate a markdown page of ranked open-source projects based on a list of projects defined in a `yaml` file. It is integrated with different package managers - such as PyPI, NPM, Conda, and Docker Hub - to automatically collect a variety of project metadata and calculate project-quality scores. It also comes with a GitHub Action workflow for a fully automized update process. > 🧙‍♂️ Create your own best-of list in just 3 minutes with [this guide](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md). ## Highlights - 📇&nbsp; Generates a beautiful markdown page from a `yaml` list. - 🔌&nbsp; Integrates various package managers (npm, pypi, conda ...). - 🥇&nbsp; Calculates a project-quality score based on a variety of metrics. - 📈&nbsp; Identifies trending projects based on collected metrics. - 🔄&nbsp; GitHub Action workflow for automated weekly updates. ## Getting Started > 🧙‍♂️ If you want to create your own best-of list, we strongly recommend to follow [this guide](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md) instead of setting up best-of manually. With the guide, it will only take about 3 minutes to get you started. It is already set-up to automatically run the best-of generator via our GitHub Action and includes other useful template files. Installing the best-of CLI tool is not required. 1. Install best-of generator via pip: ```bash pip install best-of ``` 2. Create a `projects.yaml` file based on the [documented structure](#projectsyaml-structure). This file should contain at least one project. For example: ```yaml projects: - name: "best-of-ml-python" github_id: "ml-tooling/best-of-ml-python" ``` 3. Run best-of generator via command-line: ```bash best-of generate -g <GITHUB_API_TOKEN> ./projects.yaml ``` You can find further information on how to configure the `projects.yaml` file and additional features in the [documentation section](#documentation) below. ## Support & Feedback This project is maintained by [Benjamin Räthlein](https://twitter.com/raethlein), [Lukas Masuch](https://twitter.com/LukasMasuch), and [Jan Kalkan](https://www.linkedin.com/in/jan-kalkan-b5390284/). Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly so that more people can benefit from it. | Type | Channel | | ------------------------ | ------------------------------------------------------ | | 🚨&nbsp; **Bug Reports** | <a href="https://github.com/best-of-lists/best-of-generator/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3Abug+sort%3Areactions-%2B1-desc+" title="Open Bug Report"><img src="https://img.shields.io/github/issues/best-of-lists/best-of-generator/bug.svg?label=bug"></a> | | 🎁&nbsp; **Feature Requests** | <a href="https://github.com/best-of-lists/best-of-generator/issues?q=is%3Aopen+is%3Aissue+label%3Afeature+sort%3Areactions-%2B1-desc" title="Open Feature Request"><img src="https://img.shields.io/github/issues/best-of-lists/best-of-generator/feature.svg?label=feature%20request"></a> | | 👩‍💻&nbsp; **Usage Questions** | <a href="https://github.com/best-of-lists/best-of-generator/issues?q=is%3Aopen+is%3Aissue+label%3Asupport+sort%3Areactions-%2B1-desc" title="Open Support Request"> <img src="https://img.shields.io/github/issues/best-of-lists/best-of-generator/support.svg?label=support%20request"></a> <a href="https://gitter.im/ml-tooling/best-of" title="Chat on Gitter"><img src="https://badges.gitter.im/ml-tooling/best-of.svg"></a> | | 📢&nbsp; **Announcements** | <a href="https://gitter.im/ml-tooling/best-of" title="Chat on Gitter"><img src="https://badges.gitter.im/ml-tooling/best-of.svg"></a> <a href="https://bestoflists.substack.com/subscribe" title="Subscribe for updates"><img src="http://bit.ly/2Md9rxM"></a> <a href="https://twitter.com/best_of_lists" title="Best-of on Twitter"><img src="https://img.shields.io/twitter/follow/best_of_lists.svg?style=social&label=Follow"> | | ❓&nbsp; **Other Requests** | <a href="mailto:best-of@mltooling.org" title="Email best-of team"><img src="https://img.shields.io/badge/email-best of-green?logo=mail.ru&logoColor=white"></a> | ## Documentation <p align="center"> <a href="#projectsyaml-structure">YAML Structure</a> • <a href="#projects">Projects</a> • <a href="#categories">Categories</a> • <a href="#labels">Labels</a> • <a href="#configuration">Configuration</a> • <a href="#project-quality-score">Project Quality Score</a> • <a href="#trending-projects">Trending Projects</a> • <a href="#generation-via-cli">CLI</a> • <a href="#generation-via-github-action">GitHub Action</a> • <a href="#generation-via-python-api">Python API</a> </p> The best-of generator is a CLI tool to generate a markdown page from a list of projects configured in a `yaml` file. The documentation sections below will provide information on the [`projects.yaml` structure](#projectsyaml-structure), on its different sections ([projects](#projects), [labels](#labels), [categories](#categories) & [configuration]((#configuration))), on some of the best-of features (e.g. [project-quality score](#project-quality-score) & [trending projects](#trending-projects)), and instructions on how to run the markdown generation [via the command-line interface](#generation-via-cli) or [via GitHub Actions](#generation-via-github-action). ### `projects.yaml` Structure The `projects.yaml` file has the following structure: - `configurations` (optional): Can be used to overwrite the default configuration of the best-of list. More information in the [configuration section](#configuration). - `categories` (required): All used categories should be listed here with at least a descriptive title. More information in the [categories section](#categories). - `labels` (optional): Used labels can be added here to extend the label with additional aspects (e.g. URL, image, description). More information in the [labels section](#labels). - `projects` (required): All projects that are supposed to be shown in the generated markdown page should be li