Merge pull request #9 from l3ocho/development

Development
This commit is contained in:
Leo Miranda
2025-10-23 12:28:40 -04:00
committed by GitHub
8 changed files with 1895 additions and 19 deletions

View File

@@ -760,7 +760,7 @@ This document evolves based on development experience:
**DEPLOYMENT STRATEGY**:
- Maintain backward compatibility with v0.1.0
- Gitea-only deployment continues
- Users install via: `pip install git+https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python.git@v0.2.0`
- Users install via: `pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git@v0.2.0`
**DEVELOPMENT PRINCIPLES**:
1.**Test-Driven Development**: Write tests first, then implementation

View File

@@ -2,8 +2,8 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python Support](https://img.shields.io/badge/python-3.8+-blue.svg)](https://python.org)
[![Repository](https://img.shields.io/badge/repo-Gitea-green.svg)](https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python)
[![Issues](https://img.shields.io/badge/issues-Gitea-blue.svg)](https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python/issues)
[![Repository](https://img.shields.io/badge/repo-Gitea-green.svg)](https://gitea.hotserv.cloud/lmiranda/py-wikijs)
[![Issues](https://img.shields.io/badge/issues-Gitea-blue.svg)](https://gitea.hotserv.cloud/lmiranda/py-wikijs/issues)
**A professional Python SDK for Wiki.js API integration.**
@@ -18,10 +18,10 @@
### Installation
```bash
# Install directly from Gitea
pip install git+https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python.git
pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git
# Or clone and install locally
git clone https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python.git
git clone https://gitea.hotserv.cloud/lmiranda/py-wikijs.git
cd wikijs-python-sdk
pip install -e .
```
@@ -118,7 +118,7 @@ We welcome contributions! This project showcases systematic development with pro
### Local Development
```bash
# Clone and setup
git clone https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python.git
git clone https://gitea.hotserv.cloud/lmiranda/py-wikijs.git
cd wikijs-python-sdk
pip install -e ".[dev]"

View File

@@ -22,7 +22,7 @@ This project was developed by leomiranda, showcasing professional development pr
1. **Fork the Repository**
```bash
# Fork on Gitea, then clone your fork
git clone https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python.git
git clone https://gitea.hotserv.cloud/lmiranda/py-wikijs.git
cd wikijs-python-sdk
```
@@ -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 issues in the [repository](https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python/issues)
3. Look for issues in the [repository](https://gitea.hotserv.cloud/lmiranda/py-wikijs/issues)
4. Join the discussion!
**Questions?** Don't hesitate to create an issue in the [Gitea repository](https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python/issues).
**Questions?** Don't hesitate to create an issue in the [Gitea repository](https://gitea.hotserv.cloud/lmiranda/py-wikijs/issues).

File diff suppressed because it is too large Load Diff

View File

@@ -1,7 +1,7 @@
# Wiki.js Python SDK - Release Plan
**Project Name:** `wikijs-python-sdk`
**Repository:** `https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python`
**Repository:** `https://gitea.hotserv.cloud/lmiranda/py-wikijs`
**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 git+https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python.git`
- [ ] Package installable via `pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git`
- [ ] Basic page operations work with real Wiki.js instance
- [ ] >85% test coverage with passing CI/CD
- [ ] Complete API documentation

View File

@@ -60,10 +60,10 @@ all = [
]
[project.urls]
Homepage = "https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python"
"Bug Reports" = "https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python/issues"
Source = "https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python"
Documentation = "https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python/src/branch/main/docs"
Homepage = "https://gitea.hotserv.cloud/lmiranda/py-wikijs"
"Bug Reports" = "https://gitea.hotserv.cloud/lmiranda/py-wikijs/issues"
Source = "https://gitea.hotserv.cloud/lmiranda/py-wikijs"
Documentation = "https://gitea.hotserv.cloud/lmiranda/py-wikijs/src/branch/main/docs"
[tool.setuptools.dynamic]
version = {attr = "wikijs.version.__version__"}

View File

@@ -49,11 +49,11 @@ setup(
long_description_content_type="text/markdown",
author="leomiranda",
author_email="lmiranda@hotserv.cloud",
url="https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python",
url="https://gitea.hotserv.cloud/lmiranda/py-wikijs",
project_urls={
"Bug Reports": "https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python/issues",
"Source": "https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python",
"Documentation": "https://gitea.hotserv.cloud/lmiranda/wikijs-sdk-python/src/branch/main/docs",
"Bug Reports": "https://gitea.hotserv.cloud/lmiranda/py-wikijs/issues",
"Source": "https://gitea.hotserv.cloud/lmiranda/py-wikijs",
"Documentation": "https://gitea.hotserv.cloud/lmiranda/py-wikijs/src/branch/main/docs",
},
packages=find_packages(),
include_package_data=True,