Merge pull request #3 from mkdocs/require-homepage

Add require_homepage option

Author: pawamoy

README.md

@@ -476,6 +476,11 @@ The configuration example above changes the default configuration to show all pr
  <td>Project will be hidden if it has a less stars on GitHub.</td>
  <td><code>100</code></td>
  </tr>
+ <tr>
+ <td><code>require_homepage</code></td>
+ <td>If <code>True</code>, all projects without a detected homepage will be hidden.</td>
+ <td><code>True</code></td>
+ </tr>
  <tr>
  <td><code>require_license</code></td>
  <td>If <code>True</code>, all projects without a detected license will be hidden.</td>

src/best_of/default_config.py

@@ -28,6 +28,9 @@ def prepare_configuration(cfg: dict) -> Dict:
  if "min_stars" not in config:
  config.min_stars = 100
 
+ if "require_homepage" not in config:
+ config.require_homepage = True
+
  if "require_license" not in config:
  config.require_license = True
 

src/best_of/projects_collection.py

@@ -394,7 +394,7 @@ def apply_filters(project_info: Dict, configuration: Dict) -> None:
  project_info.show = False
  return
 
- if not project_info.homepage:
+ if not project_info.homepage and configuration.require_homepage:
  log.info(f"Could not find a valid homepage for {project_info.name}")
  project_info.show = False