Major project overhaul: docs translation, new modules, examples, CI, … #78

Merged

ESousa97 merged 6 commits from feature/new-version into main 2025-12-04 01:48:45 -05:00

Conversation 0 Commits 6 Files changed 43 +4435 -774

ESousa97 commented 2025-12-03 19:07:37 -05:00 (Migrated from github.com)

Copy link

Hi! 👋
My name is Enoque Sousa, and this is my first contribution to this project.
Since I discovered this repository, I took some time to deeply review its structure, documentation, and overall. The goal of this PR is to modernize the project, improve clarity, and provide a more robust foundation for future development.

Over the last few days, I focused on reorganizing the codebase, refactoring the client implementations, updating the package structure, and creating clear, practical examples for new users. I also rebuilt the documentation so the project becomes easier to understand and maintain.

Below is the full summary of everything included in this update:

• Fully, reorganized, and standardized documentation (README, docs/*, examples/README)
• Added new usage guides, recipes, and English roadmap
• Introduced core modules: config.py, logger.py, exceptions.py, utils.py
• Refactored sync/async clients and added driver + Emailnator support
• Implemented structured logging and improved internal organization
• Formalized package via pyproject.toml with extras (driver, dev) and corrected metadata
• Added CI workflows (.github/workflows/*) and standardized log output (perplexity.log)
• Created new example suite: basic, streaming, async, upload, account creation, batch
• Added helper scripts (run.py) and improved overall developer experience
• Updated verify_implementation.py to reflect new project structure and remove obsolete test checks
• Cleaned up tests directory and removed deprecated test files
• Ensured verifier no longer triggers pytest to avoid false negatives

Hi! 👋 My name is Enoque Sousa, and this is my first contribution to this project. Since I discovered this repository, I took some time to deeply review its structure, documentation, and overall. The goal of this PR is to modernize the project, improve clarity, and provide a more robust foundation for future development. Over the last few days, I focused on reorganizing the codebase, refactoring the client implementations, updating the package structure, and creating clear, practical examples for new users. I also rebuilt the documentation so the project becomes easier to understand and maintain. Below is the full summary of everything included in this update: - Fully, reorganized, and standardized documentation (README, docs/*, examples/README) - Added new usage guides, recipes, and English roadmap - Introduced core modules: config.py, logger.py, exceptions.py, utils.py - Refactored sync/async clients and added driver + Emailnator support - Implemented structured logging and improved internal organization - Formalized package via pyproject.toml with extras (driver, dev) and corrected metadata - Added CI workflows (.github/workflows/*) and standardized log output (perplexity.log) - Created new example suite: basic, streaming, async, upload, account creation, batch - Added helper scripts (run.py) and improved overall developer experience - Updated verify_implementation.py to reflect new project structure and remove obsolete test checks - Cleaned up tests directory and removed deprecated test files - Ensured verifier no longer triggers pytest to avoid false negatives

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels

No items

No labels

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

helallao/perplexity-ai!78

No description provided.