personal-projects/py-wikijs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: Rename package from wikijs-python-sdk to py-wikijs and migrate to GitHub

Browse Source 
Complete package renaming and platform migration:

Package Name Changes:
- Rename package from 'wikijs-python-sdk' to 'py-wikijs'
- Update setup.py package name
- Update pyproject.toml package name
- Users can now install with: pip install py-wikijs

URL Migration (Gitea → GitHub):
- Replace all Gitea URLs with GitHub URLs
- Update repository: github.com/l3ocho/py-wikijs
- Update issue tracker: github.com/l3ocho/py-wikijs/issues
- Update documentation links
- Fix URL path format (/src/branch/main/ → /blob/main/)

Documentation Updates:
- Update README.md badges (PyPI, GitHub)
- Update installation instructions (pip install py-wikijs)
- Update all doc references to new package name
- Update all examples with GitHub URLs
- Update DEPLOYMENT_READY.md with new package name
- Update deployment.md with new package name

Testing:
- Successfully built py_wikijs-0.1.0.tar.gz (138 KB)
- Successfully built py_wikijs-0.1.0-py3-none-any.whl (66 KB)
- Package installs correctly: pip install py-wikijs
- Imports work: from wikijs import WikiJSClient
- Package metadata correct (Home-page: github.com/l3ocho/py-wikijs)

Breaking Changes:
- Package name changed from wikijs-python-sdk to py-wikijs
- Repository migrated from Gitea to GitHub
- All URLs updated to GitHub

Users should now:
pip install py-wikijs  # Instead of wikijs-python-sdk

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Claude
2025-10-23 20:23:50 +00:00
parent c18d00cd47
commit 59cdf5ee01
52 changed files with 128 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/CONTRIBUTING.md
View File

@@ -22,8 +22,8 @@ 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/py-wikijs.git
cd wikijs-python-sdk
git clone https://github.com/l3ocho/py-wikijs.git
cd py-wikijs
```
2. **Set Up Development Environment**
@@ -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/py-wikijs/issues)
3. Look for issues in the [repository](https://github.com/l3ocho/py-wikijs/issues)
4. Join the discussion!
**Questions?** Don't hesitate to create an issue in the [Gitea repository](https://gitea.hotserv.cloud/lmiranda/py-wikijs/issues).
**Questions?** Don't hesitate to create an issue in the [Gitea repository](https://github.com/l3ocho/py-wikijs/issues).

2
docs/GOVERNANCE.md
View File

@@ -1,6 +1,6 @@
# Wiki.js Python SDK - Community Governance
**Project**: wikijs-python-sdk
**Project**: py-wikijs
**Stage**: MVP Development
**Version**: 1.0
**Last Updated**: July 2025

2
docs/RISK_MANAGEMENT.md
View File

@@ -1,6 +1,6 @@
# Wiki.js Python SDK - Risk Management
**Project**: wikijs-python-sdk
**Project**: py-wikijs
**Stage**: MVP Development
**Version**: 1.0
**Last Updated**: July 2025

2
docs/async_usage.md
View File

@@ -5,7 +5,7 @@ The Wiki.js Python SDK provides full async/await support for high-performance co
## Installation
```bash
pip install wikijs-python-sdk[async]
pip install py-wikijs[async]
```
## Quick Start

4
docs/compatibility.md
View File

@@ -379,7 +379,7 @@ client_v3 = WikiJSClientV3(...) # Force 3.x API
- **Documentation**: [Full documentation](../README.md)
- **Examples**: [Usage examples](../examples/)
- **Issues**: [Report compatibility issues](https://gitea.hotserv.cloud/lmiranda/py-wikijs/issues)
- **Issues**: [Report compatibility issues](https://github.com/l3ocho/py-wikijs/issues)
### Resources
@@ -402,4 +402,4 @@ client_v3 = WikiJSClientV3(...) # Force 3.x API
**Last Updated**: October 2025
**Next Review**: When Wiki.js 3.0 beta is released
For the latest compatibility information, always check this guide or visit the [project repository](https://gitea.hotserv.cloud/lmiranda/py-wikijs).
For the latest compatibility information, always check this guide or visit the [project repository](https://github.com/l3ocho/py-wikijs).

22
docs/deployment.md
View File

@@ -7,7 +7,7 @@
## 📋 Overview
This guide covers how to build, test, and publish the `wikijs-python-sdk` package to PyPI (Python Package Index).
This guide covers how to build, test, and publish the `py-wikijs` package to PyPI (Python Package Index).
---
@@ -57,7 +57,7 @@ pip install build twine
2. **Create API Token**:
- Go to https://pypi.org/manage/account/
- Click "Add API token"
- Name: `wikijs-python-sdk-upload`
- Name: `py-wikijs-upload`
- Scope: Entire account (or specific project after first upload)
3. **Save Token Securely**: Store in password manager or environment variable
@@ -218,7 +218,7 @@ python -m twine upload --repository testpypi dist/*
# Install from TestPyPI
pip install --index-url https://test.pypi.org/simple/ \
--extra-index-url https://pypi.org/simple/ \
wikijs-python-sdk
py-wikijs
# Test the installation
python -c "from wikijs import WikiJSClient; print('TestPyPI install successful')"
@@ -253,17 +253,17 @@ python -m twine upload dist/*
# Uploading wikijs_python_sdk-0.2.0-py3-none-any.whl
# Uploading wikijs_python_sdk-0.2.0.tar.gz
# View at:
# https://pypi.org/project/wikijs-python-sdk/0.2.0/
# https://pypi.org/project/py-wikijs/0.2.0/
```
### 3. Verify Publication
```bash
# Visit PyPI page
# https://pypi.org/project/wikijs-python-sdk/
# https://pypi.org/project/py-wikijs/
# Test installation from PyPI
pip install wikijs-python-sdk
pip install py-wikijs
# Verify version
python -c "from wikijs import __version__; print(__version__)"
@@ -358,7 +358,7 @@ python -m twine upload dist/*
# Solution: Choose a different package name
# 1. Update name in setup.py and pyproject.toml
# 2. Rebuild package
# Note: wikijs-python-sdk is our chosen name
# Note: py-wikijs is our chosen name
```
### Installation Issues
@@ -367,8 +367,8 @@ python -m twine upload dist/*
```bash
# Solution: Check dependencies are installed
pip show wikijs-python-sdk
pip install wikijs-python-sdk[all] # Install all optional deps
pip show py-wikijs
pip install py-wikijs[all] # Install all optional deps
```
**Problem**: Import errors with type hints
@@ -394,14 +394,14 @@ ls -lh dist/
# Check dependency tree
pip install pipdeptree
pipdeptree -p wikijs-python-sdk
pipdeptree -p py-wikijs
```
### Download Stats
After publication, monitor package metrics:
- **PyPI Stats**: https://pypistats.org/packages/wikijs-python-sdk
- **PyPI Stats**: https://pypistats.org/packages/py-wikijs
- **GitHub Stats**: Stars, forks, watchers
- **Issue Tracker**: Open issues, response time

6
docs/development.md
View File

@@ -26,8 +26,8 @@ Guide for contributors and developers working on the Wiki.js Python SDK.
1. **Clone the repository:**
```bash
git clone https://github.com/yourusername/wikijs-python-sdk.git
cd wikijs-python-sdk
git clone https://github.com/yourusername/py-wikijs.git
cd py-wikijs
```
2. **Create a virtual environment:**
@@ -70,7 +70,7 @@ python -c "from wikijs import WikiJSClient; print('✅ Setup successful!')"
## Project Structure
```
wikijs-python-sdk/
py-wikijs/
├── wikijs/ # Main package
│ ├── __init__.py # Package exports
│ ├── version.py # Version information

36
docs/plans/IMPROVEMENT_PLAN_2.md
View File

@@ -516,7 +516,7 @@ pytest -v --cov=wikijs --cov-report=term-missing --cov-report=html
**File**: `wikijs/logging.py` (NEW)
```python
"""Logging configuration for wikijs-python-sdk."""
"""Logging configuration for py-wikijs."""
import logging
import json
import sys
@@ -784,7 +784,7 @@ JSON logs include:
**File**: `wikijs/metrics.py` (NEW)
```python
"""Metrics and telemetry for wikijs-python-sdk."""
"""Metrics and telemetry for py-wikijs."""
import time
from dataclasses import dataclass, field
from typing import Dict, List, Optional
@@ -1001,7 +1001,7 @@ print(f"P95 latency: {metrics['latency']['p95']:.2f}ms")
**File**: `wikijs/ratelimit.py` (NEW)
```python
"""Rate limiting for wikijs-python-sdk."""
"""Rate limiting for py-wikijs."""
import time
import threading
from typing import Optional
@@ -1156,7 +1156,7 @@ pip install build twine
**File**: `setup.py` (VERIFY)
```python
setup(
name="wikijs-python-sdk", # or "py-wikijs"
name="py-wikijs", # or "py-wikijs"
version=read_version(),
# ... existing config ...
classifiers=[
@@ -1195,7 +1195,7 @@ rm -rf dist/ build/ *.egg-info
python -m build
# Verify contents
tar -tzf dist/wikijs-python-sdk-*.tar.gz
tar -tzf dist/py-wikijs-*.tar.gz
unzip -l dist/wikijs_python_sdk-*.whl
# Check package
@@ -1209,7 +1209,7 @@ twine check dist/*
twine upload --repository testpypi dist/*
# Test installation
pip install --index-url https://test.pypi.org/simple/ wikijs-python-sdk
pip install --index-url https://test.pypi.org/simple/ py-wikijs
# Verify import
python -c "from wikijs import WikiJSClient; print('Success!')"
@@ -1222,10 +1222,10 @@ python -c "from wikijs import WikiJSClient; print('Success!')"
twine upload dist/*
# Verify on PyPI
# https://pypi.org/project/wikijs-python-sdk/
# https://pypi.org/project/py-wikijs/
# Test installation
pip install wikijs-python-sdk
pip install py-wikijs
```
#### Step 5: Update Documentation
@@ -1236,18 +1236,18 @@ pip install wikijs-python-sdk
### From PyPI (Recommended)
```bash
pip install wikijs-python-sdk
pip install py-wikijs
# With async support
pip install wikijs-python-sdk[async]
pip install py-wikijs[async]
# With all extras
pip install wikijs-python-sdk[all]
pip install py-wikijs[all]
```
### From Source
```bash
pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git
pip install git+https://github.com/l3ocho/py-wikijs.git
```
```
@@ -1276,7 +1276,7 @@ pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git
### Success Criteria
- [ ] Package published to PyPI
- [ ] Installation works: `pip install wikijs-python-sdk`
- [ ] Installation works: `pip install py-wikijs`
- [ ] README updated with PyPI instructions
- [ ] Release notes created
- [ ] Version tagged in git
@@ -1379,7 +1379,7 @@ Once a vulnerability is fixed:
**File**: `wikijs/cli/__init__.py` (NEW)
```python
"""Command-line interface for wikijs-python-sdk."""
"""Command-line interface for py-wikijs."""
import click
from rich.console import Console
from rich.table import Table
@@ -1535,7 +1535,7 @@ setup(
```bash
# Install with CLI
pip install wikijs-python-sdk[cli]
pip install py-wikijs[cli]
# Set environment
export WIKIJS_URL="https://wiki.example.com"
@@ -1681,7 +1681,7 @@ open _build/html/index.html
**File**: `wikijs/plugins/base.py` (NEW)
```python
"""Plugin system for wikijs-python-sdk."""
"""Plugin system for py-wikijs."""
from abc import ABC, abstractmethod
from typing import Any, Dict, Optional
@@ -1868,8 +1868,8 @@ git checkout -b phase-2.5-foundation-fixes
### Questions?
- 📧 Email: lmiranda@hotserv.cloud
- 🐛 Issues: https://gitea.hotserv.cloud/lmiranda/py-wikijs/issues
- 📚 Docs: https://gitea.hotserv.cloud/lmiranda/py-wikijs/src/branch/main/docs
- 🐛 Issues: https://github.com/l3ocho/py-wikijs/issues
- 📚 Docs: https://github.com/l3ocho/py-wikijs/blob/main/docs
---

2
docs/user_guide.md
View File

@@ -18,7 +18,7 @@ Complete guide to using the Wiki.js Python SDK for common tasks and workflows.
### Installation
```bash
pip install wikijs-python-sdk
pip install py-wikijs
```
### Basic Setup

2
docs/users_api.md
View File

@@ -741,5 +741,5 @@ Search for users by name or email.
## Support
For issues and questions:
- GitHub Issues: [wikijs-python-sdk/issues](https://github.com/yourusername/wikijs-python-sdk/issues)
- GitHub Issues: [py-wikijs/issues](https://github.com/yourusername/py-wikijs/issues)
- Documentation: [Full Documentation](../README.md)

2
docs/wikijs_sdk_architecture.md
View File

@@ -224,7 +224,7 @@ flowchart TD
### Directory Layout
```
wikijs-python-sdk/
py-wikijs/
├── wikijs/ # Main package
│ ├── __init__.py # Package entry point
│ ├── client.py # Main client class

6
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://gitea.hotserv.cloud/lmiranda/py-wikijs`
**Project Name:** `py-wikijs`
**Repository:** `https://github.com/l3ocho/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/py-wikijs.git`
- [ ] Package installable via `pip install git+https://github.com/l3ocho/py-wikijs.git`
- [ ] Basic page operations work with real Wiki.js instance
- [ ] >85% test coverage with passing CI/CD
- [ ] Complete API documentation