Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v2.0.0 - Refactored Project Structure and Enhanced SDK Operations #14

Merged
merged 6 commits into from
Dec 5, 2024

Conversation

shiningflash
Copy link
Owner

@shiningflash shiningflash commented Dec 5, 2024

Summary:

This release (v2.0.0) introduces a significant refactoring of the project structure and enhancements to SDK operations.

Key Features:

  1. Improved Project Structure:

    • Split core/exceptions.py into modular components: api.py, decorators.py, and resource.py.
    • Updated directory structure for better alignment with OpenAPI and best practices.
  2. Enhanced SDK Error Handling:

    • Robust handling for ContactNotFoundError and MessageNotFoundError.
    • Refactored handle_404_error for dynamic resource type support.
  3. Testing Enhancements:

    • Improved unit tests for contacts and messages modules.
    • Verified test coverage exceeds 93% across all components.
  4. Documentation Updates:

    • Reflected refactoring changes in README.md.
    • Added detailed directory structure for improved developer onboarding.

Release Notes:

  • Version: 2.0.0

Instructions:

  • Ensure .env is configured correctly using .env.example.
  • Verify CI/CD workflows and test coverage remain stable post-release.

- Restructured the project to align better with OpenAPI specifications and best practices.
- Split `/src/core/exceptions.py` into modular components: `api.py`, `decorators.py`, and `resource.py`.
- Enhanced `ContactNotFoundError` and `MessageNotFoundError` handling for robust SDK operations.
- Updated and optimized unit tests for `contacts` and `messages` modules with improved error handling.
- Revised the directory structure for better readability and maintainability.
- Updated documentation to reflect the latest project structure and design changes.
Refactoring 2.0: Improved Project Structure and Exception Handling
@shiningflash shiningflash added Code Reviewed Security Reviewed documentation Improvements or additions to documentation labels Dec 5, 2024
Copy link

github-actions bot commented Dec 5, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/core
   __init__.py00100% 
   config.py2222 91%
   logger.py220100% 
   requests.py1544 73%
   retry.py2111 95%
   security.py2622 92%
   validators.py400100% 
src/core/exceptions
   __init__.py40100% 
   api.py2911 97%
   decorators.py2377 70%
   resource.py130100% 
src/schemas
   __init__.py00100% 
   contacts.py2633 88%
   errors.py170100% 
   messages.py2722 93%
   webhook.py80100% 
src/sdk
   __init__.py00100% 
   client.py390100% 
src/sdk/features
   __init__.py00100% 
   contacts.py4833 94%
   messages.py3433 91%
src/server
   __init__.py00100% 
   app.py2633 88%
TOTAL4403193% 

Tests Skipped Failures Errors Time
55 0 💤 0 ❌ 0 🔥 6.820s ⏱️

@shiningflash shiningflash merged commit b8a7539 into main Dec 5, 2024
1 check passed
@shiningflash shiningflash changed the title Release 2.0: Refactored Project Structure and Enhanced SDK Operations Release v2.0.0 - Refactored Project Structure and Enhanced SDK Operations Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code Reviewed documentation Improvements or additions to documentation Security Reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant