Matthew Raymer
|
5ecde954b7
|
docs: improve documentation across WebPushService class
Comprehensive documentation update focusing on clarity and completeness while
maintaining technical accuracy. Key improvements include:
- Add detailed module-level documentation with features and dependencies
- Enhance class-level documentation with responsibilities and endpoints
- Improve method documentation with:
- Clear workflow descriptions
- Technical implementation details
- Security considerations
- Database impacts
- Error handling specifics
- Usage examples
- Return type clarification
- Thread safety notes
Technical Changes:
- Replace print statements with structured logging using structlog
- Add specific error handling for SQLAlchemy and cryptography exceptions
- Add type hints and improve return type annotations
Security:
- Document authentication requirements
- Add security considerations sections
- Clarify VAPID key handling
- Document input validation
Dependencies:
- Add structlog>=24.1.0 to requirements.txt
This improves code maintainability and helps future developers understand
the system's security and operational characteristics.
|
2 weeks ago |
Trent Larson
|
6cc35fbd43
|
add a customizable message, plus other fixes
|
3 months ago |
Trent Larson
|
ee1da3399a
|
commentarly like changelog update
|
11 months ago |
Trent Larson
|
400d9e6eb0
|
update docker build with version, add changelog
|
11 months ago |
Trent Larson
|
62c76eb651
|
accept parameters for the daily notification time
|
11 months ago |
Trent Larson
|
2a9b1fcf75
|
run the notification check frequently throughout the day, and allow different times for users
|
11 months ago |
Trent Larson
|
5071a8bee4
|
add a 'ping' endpoint, redirect stderr to stdout
|
11 months ago |
Trent Larson
|
b53d7a5e0d
|
add more logging
|
1 year ago |
Trent Larson
|
6f47d91c58
|
fix reference in commentary
|
1 year ago |
Trent Larson
|
c1ed026662
|
update the title of daily checks to match Time Safari
|
1 year ago |
Trent Larson
|
a466968de4
|
fix another dict/attribute problem
|
1 year ago |
Trent Larson
|
acb37a50c1
|
fix dict key references
|
1 year ago |
Trent Larson
|
3c0e196c11
|
add ability to send back a chosen title & message
|
1 year ago |
Trent Larson
|
a3d22d25f4
|
finish send-test endpoint which now works
|
1 year ago |
Trent Larson
|
af85b971b1
|
fix some things that are wrong in the data structures
|
1 year ago |
Trent Larson
|
31e7f5048f
|
add send-test as generated by Aider & ChatGPT
|
1 year ago |
Trent Larson
|
9e85f15951
|
refactor method results for consistent types
|
1 year ago |
Trent Larson
|
140e426458
|
remove extra spaces before newlines (no code/logic changes)
|
1 year ago |
Trent Larson
|
1edeb89144
|
flush the prints in a separate thread
|
1 year ago |
Matthew Raymer
|
6558aeab22
|
Updates to delete missing subscriptions
|
1 year ago |
Trent Larson
|
561b04c678
|
add messages for subscription loop
|
1 year ago |
Trent Larson
|
21ebf79f6f
|
add instructions for admin password
|
1 year ago |
Trent Larson
|
35747dff26
|
add a password for the regenerate_vapid endpoint
|
1 year ago |
Trent Larson
|
4536f2268c
|
update email for production
|
1 year ago |
Trent Larson
|
01d3868b80
|
fix endpoint for regenerating VAPID key
|
1 year ago |
Trent Larson
|
8d003876a8
|
revert the default path to the DB
|
1 year ago |
Trent Larson
|
e8a33e876c
|
make docker path consistent, and enhance instructions
|
1 year ago |
Trent Larson
|
72653abaf5
|
fix DB path and add instructions for docker deployment
|
1 year ago |
Matthew Raymer
|
b8b47caf55
|
bugfix and documentation
|
1 year ago |
Matthew Raymer
|
53d2a31da7
|
OOP and documented
|
1 year ago |
Matthew Raymer
|
2b048c5a77
|
Refactored to class with long-running thread
|
1 year ago |
Matthew Raymer
|
bd4a38235e
|
Clean up the private key creation and lookup
|
1 year ago |
Matthew Raymer
|
efedd5fa08
|
Add a pause before sending to the gateway
|
1 year ago |
Matthew Raymer
|
d3603209c7
|
Fix field name
|
1 year ago |
Matthew Raymer
|
bdbbc09376
|
Raw DER in base64
|
1 year ago |
Matthew Raymer
|
602851b30e
|
Up until sending message. Try turning into a PEM
|
1 year ago |
Matthew Raymer
|
76ee4ef428
|
Some adjustments to my first attempt. Try tomorow!
|
1 year ago |
Matthew Raymer
|
d2d4071c61
|
Somewhat stable VAPID generation
|
1 year ago |
Matthew Raymer
|
ebebd2fce2
|
Got gunicorn working. Problem with sqlite intiailization to fix.
|
1 year ago |
Matthew Raymer
|
2322ab7c83
|
WIP: building up VAPID and subscription
|
1 year ago |