Skip to content

Commit 6491c6c

Browse files
chore: simplify project documentation and configuration
- Rewrite README.md for conciseness and remove legacy example scripts - Relax ruff and mypy strictness in pyproject.toml - Add an ASCII banner to the CLI tool - Update author information and bump version to 0.1.2.dev1
1 parent ec7d101 commit 6491c6c

11 files changed

Lines changed: 104 additions & 732 deletions

File tree

README.md

Lines changed: 44 additions & 428 deletions
Large diffs are not rendered by default.

examples/__init__.py

Lines changed: 0 additions & 12 deletions
This file was deleted.

examples/anthropic_example.py

Lines changed: 0 additions & 86 deletions
This file was deleted.

examples/google_example.py

Lines changed: 0 additions & 85 deletions
This file was deleted.

examples/openai_example.py

Lines changed: 0 additions & 90 deletions
This file was deleted.

main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def display_pagans_icon(style="logo"):
5454

5555
def main():
5656
display_pagans_icon("compact")
57-
print("😅 Welcome to the future of prompt optimization!")
57+
print("Welcome to PAGANS prompt optimization.")
5858
print("Optimize your prompts across OpenAI GPT, Anthropic Claude, and Google Gemini models.")
5959
print("Use 'pagans' command-line tool or import the library in your Python projects.")
6060
print("\nFor more information, visit: https://github.com/abubakarsiddik31/pagans")

pyproject.toml

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
55
[project]
66
name = "pagans"
77
dynamic = ["version"]
8-
description = "😅 Prompts Aligned to Guidelines and Normalization System - Optimize prompts for OpenAI, Anthropic, xAI, and Google models"
8+
description = "Prompts Aligned to Guidelines and Normalization System for OpenAI, Anthropic, xAI, and Google models"
99
readme = "README.md"
1010
license = {text = "MIT"}
1111
requires-python = ">=3.12"
@@ -27,10 +27,10 @@ keywords = [
2727
"artificial-intelligence"
2828
]
2929
authors = [
30-
{name = "PAGANS Team", email = "abubakar1808031@gmail.com"}
30+
{name = "Abu Bakar Siddik", email = "abubakar1808031@gmail.com"}
3131
]
3232
maintainers = [
33-
{name = "PAGANS Team", email = "abubakar1808031@gmail.com"}
33+
{name = "Abu Bakar Siddik", email = "abubakar1808031@gmail.com"}
3434
]
3535
classifiers = [
3636
"Development Status :: 3 - Alpha",
@@ -114,8 +114,14 @@ line-length = 88
114114
target-version = "py312"
115115

116116
[tool.ruff.lint]
117-
select = ["E", "F", "W", "C90", "I", "N", "UP", "YTT", "S", "BLE", "FBT", "B", "A", "COM", "C4", "DTZ", "T10", "DJ", "EM", "EXE", "FA", "ISC", "ICN", "G", "INP", "PIE", "T20", "PYI", "PT", "Q", "RSE", "RET", "SLF", "SLOT", "SIM", "TID", "TCH", "INT", "ARG", "PTH", "ERA", "PD", "PGH", "PL", "TRY", "FLY", "NPY", "AIR", "PERF", "FURB", "LOG", "RUF"]
118-
ignore = ["S101", "S104", "COM812", "ISC001"]
117+
select = ["E", "F", "W", "I", "N"]
118+
ignore = ["E501"]
119+
120+
[tool.ruff.lint.per-file-ignores]
121+
"tests/**/*.py" = ["F841"]
122+
"src/pagans/models/__init__.py" = ["E402"]
123+
"src/pagans/__version__.py" = ["I001"]
124+
"src/pagans/_version.py" = ["I001"]
119125

120126
[tool.black]
121127
line-length = 88
@@ -127,18 +133,26 @@ line_length = 88
127133

128134
[tool.mypy]
129135
python_version = "3.12"
130-
warn_return_any = true
136+
warn_return_any = false
131137
warn_unused_configs = true
132-
disallow_untyped_defs = true
133-
disallow_incomplete_defs = true
134-
check_untyped_defs = true
135-
disallow_untyped_decorators = true
136-
no_implicit_optional = true
137-
warn_redundant_casts = true
138+
disallow_untyped_defs = false
139+
disallow_incomplete_defs = false
140+
check_untyped_defs = false
141+
disallow_untyped_decorators = false
142+
no_implicit_optional = false
143+
warn_redundant_casts = false
138144
warn_unused_ignores = true
139-
warn_no_return = true
140-
warn_unreachable = true
141-
strict_equality = true
145+
warn_no_return = false
146+
warn_unreachable = false
147+
strict_equality = false
148+
disable_error_code = [
149+
"arg-type",
150+
"assignment",
151+
"no-any-return",
152+
"no-untyped-def",
153+
"return-value",
154+
"unreachable",
155+
]
142156

143157
[tool.setuptools.package-data]
144158
"pagans" = ["optimizer_prompts/templates/**/*.jinja"]

src/pagans/__init__.py

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
"""
2-
PAGANS - Prompts Aligned to Guidelines and Normalization System 😅
3-
4-
A comprehensive Python package for optimizing prompts across different LLM model families.
5-
PAGANS provides tools to align your prompts with model-specific guidelines and normalization
6-
standards using the OpenRouter API.
7-
"""
1+
"""PAGANS package."""
82

93
from .clients.openrouter import OpenRouterClient
104
from .core import PAGANSOptimizer
@@ -40,9 +34,12 @@
4034
)
4135

4236
__version__ = "0.1.0"
43-
__author__ = "PAGANS Team"
37+
__author__ = "Abu Bakar Siddik"
4438
__email__ = "abubakar1808031@gmail.com"
45-
__description__ = "Prompts Aligned to Guidelines and Normalization System - Optimize prompts across LLM model families using OpenRouter"
39+
__description__ = (
40+
"Prompts Aligned to Guidelines and Normalization System for LLM families "
41+
"using OpenRouter"
42+
)
4643

4744
# Main exports
4845
__all__ = [

src/pagans/__version__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
commit_id: COMMIT_ID
2929
__commit_id__: COMMIT_ID
3030

31-
__version__ = version = '0.1.1.dev1'
32-
__version_tuple__ = version_tuple = (0, 1, 1, 'dev1')
31+
__version__ = version = "0.1.2.dev1"
32+
__version_tuple__ = version_tuple = (0, 1, 2, "dev1")
3333

34-
__commit_id__ = commit_id = 'gdda564782'
34+
__commit_id__ = commit_id = "gec7d101db"

0 commit comments

Comments
 (0)