lmiranda/wikijs-sdk-python
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

final commit
Some checks failed
Test Suite / lint (push) Has been cancelled
Details
Test Suite / test (3.10) (push) Has been cancelled
Details
Test Suite / test (3.11) (push) Has been cancelled
Details
Test Suite / test (3.12) (push) Has been cancelled
Details
Test Suite / test (3.8) (push) Has been cancelled
Details
Test Suite / test (3.9) (push) Has been cancelled
Details
Test Suite / security (push) Has been cancelled
Details
Test Suite / package (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Leo Miranda
2025-07-31 23:10:21 -04:00
parent f4c99ab5db
commit 3e2430fbe0
13 changed files with 178 additions and 244 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/CONTRIBUTING.md
View File

@@ -21,8 +21,8 @@ This project was developed by leomiranda, showcasing professional development pr
1. **Fork the Repository**
```bash
# Fork on GitHub, then clone your fork
git clone https://github.com/yourusername/wikijs-python-sdk.git
# Fork on Gitea, then clone your fork
git clone https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python.git
cd wikijs-python-sdk
```
@@ -55,7 +55,7 @@ This project was developed by leomiranda, showcasing professional development pr
1. **Check Current Priorities**
- Review [CLAUDE.md](CLAUDE.md) for current development tasks
- See [Development Plan](docs/wikijs_sdk_release_plan.md) for roadmap
- Look for issues labeled `good first issue`
- Look for issues in the Gitea repository
2. **Understand Architecture**
- Read [Architecture Overview](docs/wikijs_sdk_architecture.md)
@@ -275,7 +275,7 @@ def test_specific_behavior_with_expected_outcome():
Releases are managed by maintainers:
1. **Version Bump**: Update version in `wikijs/version.py`
2. **Changelog**: Update `CHANGELOG.md` with changes
2. **Changelog**: Update `docs/CHANGELOG.md` with changes
3. **Tag Release**: Create git tag `v0.1.0`
4. **Automated**: GitHub Actions handles testing and GitHub release creation
@@ -336,7 +336,7 @@ Significant contributors may be invited to become maintainers.
1. Read our [Governance](docs/GOVERNANCE.md) guidelines
2. Check the [current development status](CLAUDE.md)
3. Look for [good first issues](https://github.com/yourusername/wikijs-python-sdk/labels/good%20first%20issue)
3. Look for issues in the [repository](https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python/issues)
4. Join the discussion!
**Questions?** Don't hesitate to ask in [GitHub Discussions](https://github.com/yourusername/wikijs-python-sdk/discussions) or create an issue.
**Questions?** Don't hesitate to create an issue in the [Gitea repository](https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python/issues).

10
docs/GOVERNANCE.md
View File

@@ -112,18 +112,16 @@ Create a high-quality Python SDK for Wiki.js that serves developers' needs while
- **Level 3**: Temporary restriction from participation
- **Level 4**: Permanent ban (only for severe violations)
Report issues to: [Maintainer Contact] - all reports handled confidentially.
Report issues to: lmiranda@hotserv.cloud - all reports handled confidentially.
---
## 📞 Communication Channels
### **GitHub Issues**
### **Gitea Issues**
- Bug reports and feature requests
- Project planning and roadmap discussions
- Technical questions about implementation
### **GitHub Discussions** *(Coming Soon)*
- General help and usage questions
- Community showcase and success stories
- Brainstorming new ideas and improvements
@@ -131,7 +129,7 @@ Report issues to: [Maintainer Contact] - all reports handled confidentially.
### **Response Expectations**
- **Issues**: Response within 48-72 hours
- **Pull Requests**: Initial review within 1 week
- **Discussions**: Community-driven with maintainer backup
- **Repository discussions**: Community-driven with maintainer backup
---
@@ -178,7 +176,7 @@ This lightweight governance will evolve as the community grows:
- **[Development Plan](wikijs_sdk_release_plan.md)**: Current roadmap and priorities
- **[Architecture](wikijs_sdk_architecture.md)**: Technical design overview
- **[CLAUDE.md](../CLAUDE.md)**: Development workflow and coordination
- **[Contributing Guide](../CONTRIBUTING.md)**: Detailed contribution process *(Coming Soon)*
- **[Contributing Guide](CONTRIBUTING.md)**: Detailed contribution process
---

6
docs/development.md
View File

@@ -104,7 +104,7 @@ wikijs-python-sdk/
│ ├── development.md # This file
│ └── ...
├── examples/ # Usage examples
├── .github/ # GitHub workflows
├── .gitea/ # Gitea workflows
│ └── workflows/ # CI/CD pipelines
├── pyproject.toml # Project configuration
├── setup.py # Package setup
@@ -537,7 +537,7 @@ We use [Semantic Versioning](https://semver.org/):
### Release Steps
1. **Update version number** in `wikijs/version.py`
2. **Update CHANGELOG.md** with new version details
2. **Update docs/CHANGELOG.md** with new version details
3. **Run full test suite** and ensure all checks pass
4. **Create release commit**:
```bash
@@ -560,7 +560,7 @@ We use [Semantic Versioning](https://semver.org/):
- [ ] All tests pass
- [ ] Code coverage meets requirements (>85%)
- [ ] Documentation is updated
- [ ] CHANGELOG.md is updated
- [ ] docs/CHANGELOG.md is updated
- [ ] Version number is bumped
- [ ] No breaking changes without major version bump
- [ ] Examples work with new version

10
docs/wikijs_sdk_release_plan.md
View File

@@ -1,7 +1,7 @@
# Wiki.js Python SDK - Release Plan
**Project Name:** `wikijs-python-sdk`
**Repository:** `https://github.com/yourusername/wikijs-python-sdk`
**Repository:** `https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python`
**License:** MIT
**Target Audience:** Python developers, DevOps engineers, Data scientists
@@ -66,7 +66,7 @@ gantt
- **Documentation**: API documentation and usage examples
### Success Criteria
- [ ] Package installable via `pip install wikijs-python-sdk`
- [ ] Package installable via `pip install git+https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python.git`
- [ ] Basic page operations work with real Wiki.js instance
- [ ] >85% test coverage with passing CI/CD
- [ ] Complete API documentation
@@ -148,7 +148,7 @@ gantt
3. **Performance Benchmarking**: Regression testing
4. **Documentation Update**: Synchronized with code changes
5. **PyPI Publishing**: Automated package distribution
6. **GitHub Release**: Tagged release with changelog
6. **Gitea Release**: Tagged release with changelog
### Version Management
- **Semantic Versioning**: MAJOR.MINOR.PATCH
@@ -172,7 +172,7 @@ gantt
### Community Building
- **Documentation First**: Comprehensive guides and examples
- **Issue Templates**: Structured bug reports and feature requests
- **Issue Templates**: Structured bug reports and feature requests in Gitea
- **Contributing Guidelines**: Clear onboarding for new contributors
- **Code of Conduct**: Inclusive community standards
@@ -188,7 +188,7 @@ gantt
### Key Metrics
- **PyPI Downloads**: Measure adoption growth
- **GitHub Engagement**: Stars, forks, issues, PRs
- **Gitea Engagement**: Stars, forks, issues, PRs
- **Test Coverage**: Maintain >90% throughout development
- **Performance**: Response time and throughput benchmarks
- **Community**: Contributors, issue resolution time