Skip to content

Rules

Single Rule Logic

DeprecatedRule

Source code in searchv3/rules.py 
44
45
46
47
48
49
50
51
52
53
54
55
class DeprecatedRule(ScoreRule):
    name: str = "Deprecated Rule"
    description: str = "Check if the package is deprecated"
    max_score: int = 20
    documentation_url: str = f"{settings.DOCS_URL}/rules/#searchv3.rules.DeprecatedRule"

    def check(self, package: Package) -> CheckResult:
        if not package.is_deprecated:
            return CheckResult(
                score=self.max_score, message="Package is not deprecated."
            )
        return CheckResult(score=0, message="Package is deprecated.")

Config

Attributes:

Name Type Description
validate_assignment
Source code in searchv3/rules.py 
21
22
class Config:
    validate_assignment = True
validate_assignment class-attribute instance-attribute 
validate_assignment = True

DescriptionRule

Source code in searchv3/rules.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class DescriptionRule(ScoreRule):
    name: str = "Description Rule"
    description: str = "Check if the package has a description"
    max_score: int = 20
    documentation_url: str = (
        f"{settings.DOCS_URL}/rules/#searchv3.rules.DescriptionRule"
    )

    def check(self, package: Package) -> CheckResult:
        if package.repo_description and package.repo_description.strip():
            return CheckResult(
                score=self.max_score, message="Package has a description."
            )
        return CheckResult(score=0, message="Package has no description.")

Config

Attributes:

Name Type Description
validate_assignment
Source code in searchv3/rules.py 
21
22
class Config:
    validate_assignment = True
validate_assignment class-attribute instance-attribute 
validate_assignment = True

DownloadsRule

Source code in searchv3/rules.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
class DownloadsRule(ScoreRule):
    name: str = "Downloads Rule"
    description: str = "Score based on the number of PyPi downloads"
    max_score: int = 20
    documentation_url: str = f"{settings.DOCS_URL}/rules/#searchv3.rules.DownloadsRule"

    def check(self, package: Package) -> CheckResult:
        if package.pypi_downloads:
            score = min(int(package.pypi_downloads / 1_000), self.max_score)
            return CheckResult(
                score=score,
                message=f"Package has {package.pypi_downloads} PyPi downloads.",
            )
        return CheckResult(score=0, message="No PyPi downloads data for the package.")

Config

Attributes:

Name Type Description
validate_assignment
Source code in searchv3/rules.py 
21
22
class Config:
    validate_assignment = True
validate_assignment class-attribute instance-attribute 
validate_assignment = True

ForkRule

Source code in searchv3/rules.py 
118
119
120
121
122
123
124
125
126
127
128
129
130
131
class ForkRule(ScoreRule):
    name: str = "Fork Rule"
    description: str = "Score based on the number of forks"
    max_score: int = 20
    documentation_url: str = f"{settings.DOCS_URL}/rules/#searchv3.rules.ForkRule"

    def check(self, package: Package) -> CheckResult:
        if package.repo_forks:
            score = min(package.repo_forks, self.max_score)
            return CheckResult(
                score=score,
                message=f"Package repository has {package.repo_forks} forks.",
            )
        return CheckResult(score=0, message="No forks data for the package repository.")

Config

Attributes:

Name Type Description
validate_assignment
Source code in searchv3/rules.py 
21
22
class Config:
    validate_assignment = True
validate_assignment class-attribute instance-attribute 
validate_assignment = True

UsageCountRule

Source code in searchv3/rules.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
class UsageCountRule(ScoreRule):
    name: str = "Usage Count Rule"
    description: str = "Score based on the usage count"
    max_score: int = 20
    documentation_url: str = f"{settings.DOCS_URL}/rules/#searchv3.rules.UsageCountRule"

    def check(self, package: Package) -> CheckResult:
        usage_count = package.usage.count()
        if usage_count:
            score = min(usage_count, self.max_score)
            return CheckResult(
                score=score, message=f"Package has a usage count of {usage_count}."
            )
        return CheckResult(score=0, message="No usage data found for the package.")

Config

Attributes:

Name Type Description
validate_assignment
Source code in searchv3/rules.py 
21
22
class Config:
    validate_assignment = True
validate_assignment class-attribute instance-attribute 
validate_assignment = True

WatchersRule

Source code in searchv3/rules.py 
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
class WatchersRule(ScoreRule):
    name: str = "Watchers Rule"
    description: str = "Score based on the number of watchers"
    max_score: int = 20
    documentation_url: str = f"{settings.DOCS_URL}/rules/#searchv3.rules.WatchersRule"

    def check(self, package: Package) -> CheckResult:
        if package.repo_watchers:
            score = min(package.repo_watchers, self.max_score)
            return CheckResult(
                score=score,
                message=f"Package repository has {package.repo_watchers} watchers.",
            )
        return CheckResult(
            score=0, message="No watchers data for the package repository."
        )

Config

Attributes:

Name Type Description
validate_assignment
Source code in searchv3/rules.py 
21
22
class Config:
    validate_assignment = True
validate_assignment class-attribute instance-attribute 
validate_assignment = True

FavoritePackageRule

Source code in searchv3/rules.py 
58
59
60
61
62
63
64
65
66
67
68
69
class FavoritePackageRule(ScoreRule):
    name: str = "Favorite Package Rule"
    description: str = "Check if the package is favorite"
    max_score: int = 20
    documentation_url: str = (
        f"{settings.DOCS_URL}/rules/#searchv3.rules.FavoritePackageRule"
    )

    def check(self, package: Package) -> CheckResult:
        if package.has_favorite:
            return CheckResult(score=self.max_score, message="Package is favorite.")
        return CheckResult(score=0, message="Package is not favorite.")

Config

Attributes:

Name Type Description
validate_assignment
Source code in searchv3/rules.py 
21
22
class Config:
    validate_assignment = True
validate_assignment class-attribute instance-attribute 
validate_assignment = True

DocumentationRule

Source code in searchv3/rules.py 
88
89
90
91
92
93
94
95
96
97
98
99
class DocumentationRule(ScoreRule):
    name: str = "Documentation Rule"
    description: str = "Check if the package has a documentation URL"
    max_score: int = 20
    documentation_url: str = (
        f"{settings.DOCS_URL}/rules/#searchv3.rules.DocumentationRule"
    )

    def check(self, package: Package) -> CheckResult:
        if package.documentation_url:
            return CheckResult(score=self.max_score, message="Documentation exists.")
        return CheckResult(score=0, message="No documentation.")

Config

Attributes:

Name Type Description
validate_assignment
Source code in searchv3/rules.py 
21
22
class Config:
    validate_assignment = True
validate_assignment class-attribute instance-attribute 
validate_assignment = True

RecentReleaseRule

Source code in searchv3/rules.py 
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
class RecentReleaseRule(ScoreRule):
    name: str = "Recent Release Rule"
    description: str = "Score if the last release is less than a year old"
    max_score: int = 20
    documentation_url: str = (
        f"{settings.DOCS_URL}/rules/#searchv3.rules.RecentReleaseRule"
    )

    def check(self, package: Package) -> CheckResult:
        last_released = package.latest_version
        if not last_released or not last_released.upload_time:
            return CheckResult(
                score=0, message="No release data found for the package."
            )

        now = timezone.now()
        if now - last_released.upload_time < timedelta(365):
            return CheckResult(
                score=self.max_score,
                message="Last release is less than a year old.",
            )

        return CheckResult(score=0, message="Last release is more than a year old.")

Config

Attributes:

Name Type Description
validate_assignment
Source code in searchv3/rules.py 
21
22
class Config:
    validate_assignment = True
validate_assignment class-attribute instance-attribute 
validate_assignment = True

Group Rule Logic

ScoreRuleGroup

Attributes:

Name Type Description
description str
documentation_url str | None
max_score int
name str
Source code in searchv3/rules.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class ScoreRuleGroup(ScoreRule):
    rules: list[ScoreRule]

    def check(self, package: Package) -> CheckResult:
        results = [rule.check(package=package) for rule in self.rules]
        total_score = sum(result.score for result in results)
        max_possible_score = sum(rule.max_score for rule in self.rules)
        normalized_score = (
            (total_score / max_possible_score) * self.max_score
            if max_possible_score > 0
            else 0
        )
        messages = [result.message for result in results]
        return CheckResult(score=int(normalized_score), message=" ".join(messages))

Config

Attributes:

Name Type Description
validate_assignment
Source code in searchv3/rules.py 
21
22
class Config:
    validate_assignment = True
validate_assignment class-attribute instance-attribute 
validate_assignment = True

description instance-attribute 

description

documentation_url class-attribute instance-attribute 

documentation_url = None

max_score instance-attribute 

max_score

name instance-attribute 

name