Complete Phase 1 foundation: Tasks 1.1 and 1.2

 Task 1.1 - Project Foundation Setup:
- Repository structure with Python packaging (setup.py, pyproject.toml)
- Development dependencies and requirements
- Contributing guidelines and MIT license
- GitHub workflows for CI/CD (test.yml, release.yml)
- Issue and PR templates for community contributions
- Comprehensive project documentation

 Task 1.2 - Core Client Structure:
- wikijs package with proper module organization
- Core client class foundation in client.py
- Exception hierarchy for error handling
- Base model classes and page models
- Type checking support (py.typed)
- Utility modules and helper functions

📊 Progress: Phase 1 MVP Development now 40% complete
🎯 Next: Task 1.3 - Authentication System implementation

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
2025-07-29 13:25:36 -04:00
parent 3554d7d69c
commit 11b6be87c8
31 changed files with 3805 additions and 115 deletions

49
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,49 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[BUG] '
labels: ['bug']
assignees: ''
---
## Bug Description
A clear and concise description of what the bug is.
## Steps to Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
## Expected Behavior
A clear and concise description of what you expected to happen.
## Actual Behavior
A clear and concise description of what actually happened.
## Code Example
If applicable, add code snippets to help explain your problem.
```python
# Your code here
```
## Environment
- **SDK Version**: [e.g. 0.1.0]
- **Python Version**: [e.g. 3.11.0]
- **Operating System**: [e.g. Ubuntu 22.04]
- **Wiki.js Version**: [e.g. 2.5.300]
## Error Messages
If applicable, add any error messages or stack traces.
```
Paste error messages here
```
## Additional Context
Add any other context about the problem here.
## Possible Solution
If you have suggestions on how to fix the bug, please describe them here.

View File

@@ -0,0 +1,59 @@
---
name: Feature Request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: ['enhancement']
assignees: ''
---
## Feature Summary
A clear and concise description of the feature you'd like to request.
## Problem Statement
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Proposed Solution
Describe the solution you'd like.
A clear and concise description of what you want to happen.
## Use Case
Describe your use case for this feature.
- Who would benefit from this feature?
- What problem does it solve?
- How would you use it?
## API Design (if applicable)
If you have ideas about how the API should look, include them here.
```python
# Example of how you envision using this feature
client = WikiJSClient(...)
result = client.new_feature.do_something()
```
## Alternatives Considered
Describe alternatives you've considered.
A clear and concise description of any alternative solutions or features you've considered.
## Implementation Notes
If you have ideas about implementation, include them here.
- Are there any technical challenges?
- Dependencies that might be needed?
- Breaking changes required?
## Additional Context
Add any other context, screenshots, or examples about the feature request here.
## Priority
How important is this feature to you?
- [ ] Nice to have
- [ ] Important for my use case
- [ ] Critical for my use case
## Contribution
Are you willing to contribute to implementing this feature?
- [ ] Yes, I can implement this
- [ ] Yes, but I need guidance
- [ ] No, but I can help with testing
- [ ] No, I just want to request it