From 59cdf5ee0114856db350cfe0af2deea4d3ef8e4e Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 23 Oct 2025 20:23:50 +0000 Subject: [PATCH] refactor: Rename package from wikijs-python-sdk to py-wikijs and migrate to GitHub MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- CLAUDE.md | 6 +++--- DEPLOYMENT_READY.md | 26 +++++++++++------------ README.md | 23 +++++++++++--------- docs/CONTRIBUTING.md | 8 +++---- docs/GOVERNANCE.md | 2 +- docs/RISK_MANAGEMENT.md | 2 +- docs/async_usage.md | 2 +- docs/compatibility.md | 4 ++-- docs/deployment.md | 22 +++++++++---------- docs/development.md | 6 +++--- docs/plans/IMPROVEMENT_PLAN_2.md | 36 ++++++++++++++++---------------- docs/user_guide.md | 2 +- docs/users_api.md | 2 +- docs/wikijs_sdk_architecture.md | 2 +- docs/wikijs_sdk_release_plan.md | 6 +++--- examples/README.md | 4 ++-- examples/async_basic_usage.py | 2 +- examples/content_management.py | 2 +- examples/users_async.py | 2 +- examples/users_basic.py | 2 +- pyproject.toml | 12 +++++------ setup.py | 12 +++++------ tests/__init__.py | 2 +- tests/aio/test_async_client.py | 4 ++-- tests/auth/__init__.py | 2 +- tests/conftest.py | 2 +- tests/test_client.py | 2 +- wikijs/__init__.py | 2 +- wikijs/aio/client.py | 6 +++--- wikijs/aio/endpoints/base.py | 2 +- wikijs/aio/endpoints/pages.py | 2 +- wikijs/aio/endpoints/users.py | 2 +- wikijs/auth/__init__.py | 2 +- wikijs/auth/api_key.py | 2 +- wikijs/auth/base.py | 2 +- wikijs/auth/jwt.py | 2 +- wikijs/cache/__init__.py | 2 +- wikijs/cache/base.py | 2 +- wikijs/cache/memory.py | 2 +- wikijs/client.py | 4 ++-- wikijs/endpoints/__init__.py | 2 +- wikijs/endpoints/base.py | 2 +- wikijs/endpoints/pages.py | 2 +- wikijs/endpoints/users.py | 2 +- wikijs/exceptions.py | 2 +- wikijs/models/__init__.py | 2 +- wikijs/models/base.py | 2 +- wikijs/models/page.py | 2 +- wikijs/models/user.py | 2 +- wikijs/utils/__init__.py | 2 +- wikijs/utils/helpers.py | 2 +- wikijs/version.py | 2 +- 52 files changed, 128 insertions(+), 125 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index bcd5873..192ce3d 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -31,7 +31,7 @@ ## 📋 PROJECT CONTEXT & STATUS ### **Project Overview** -**Name**: wikijs-python-sdk +**Name**: py-wikijs **Purpose**: Professional-grade Python SDK for Wiki.js API integration **Development Approach**: AI-powered, community-driven, open source **Deployment Strategy**: Gitea-only installation (pip install git+https://gitea.hotserv.cloud/...) @@ -48,7 +48,7 @@ Target_Date: "2 weeks from start" ### **Repository Structure Status** ``` -wikijs-python-sdk/ # ✅ COMPLETE +py-wikijs/ # ✅ COMPLETE ├── README.md # ✅ COMPLETE - Central documentation hub ├── CLAUDE.md # ✅ COMPLETE - This file ├── LICENSE # ✅ COMPLETE - Task 1.1 @@ -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/py-wikijs.git@v0.2.0` +- Users install via: `pip install git+https://github.com/l3ocho/py-wikijs.git@v0.2.0` **DEVELOPMENT PRINCIPLES**: 1. ✅ **Test-Driven Development**: Write tests first, then implementation diff --git a/DEPLOYMENT_READY.md b/DEPLOYMENT_READY.md index e714bcf..4121df7 100644 --- a/DEPLOYMENT_READY.md +++ b/DEPLOYMENT_READY.md @@ -32,7 +32,7 @@ - [x] setup.py configured - [x] pyproject.toml configured - [x] Version management (wikijs/version.py) -- [x] Package name: `wikijs-python-sdk` +- [x] Package name: `py-wikijs` - [x] Author information - [x] Keywords and classifiers - [x] Project URLs @@ -48,7 +48,7 @@ ## 📦 What's Included -### Source Distribution (`wikijs_python_sdk-0.1.0.tar.gz`) +### Source Distribution (`py_wikijs-0.1.0.tar.gz`) ``` Size: ~134 KB @@ -65,7 +65,7 @@ Contents: ✅ pyproject.toml ``` -### Wheel Distribution (`wikijs_python_sdk-0.1.0-py3-none-any.whl`) +### Wheel Distribution (`py_wikijs-0.1.0-py3-none-any.whl`) ``` Size: ~66 KB @@ -97,7 +97,7 @@ python -m twine upload --repository testpypi dist/* python -m twine upload dist/* # 5. Install from PyPI -pip install wikijs-python-sdk +pip install py-wikijs # Done! Package is now publicly available ``` @@ -106,10 +106,10 @@ pip install wikijs-python-sdk ```bash # Users install directly from Git -pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git +pip install git+https://github.com/l3ocho/py-wikijs.git # Or specific version/branch -pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git@v0.1.0 +pip install git+https://github.com/l3ocho/py-wikijs.git@v0.1.0 ``` --- @@ -119,13 +119,13 @@ pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git@v0.1.0 ### Build Tests ✅ ```bash $ python -m build -Successfully built wikijs_python_sdk-0.1.0.tar.gz and wikijs_python_sdk-0.1.0-py3-none-any.whl +Successfully built py_wikijs-0.1.0.tar.gz and py_wikijs-0.1.0-py3-none-any.whl ``` ### Installation Test ✅ ```bash -$ pip install dist/wikijs_python_sdk-0.1.0-py3-none-any.whl -Successfully installed wikijs-python-sdk-0.1.0 +$ pip install dist/py_wikijs-0.1.0-py3-none-any.whl +Successfully installed py-wikijs-0.1.0 ``` ### Import Test ✅ @@ -136,8 +136,8 @@ $ python -c "from wikijs import WikiJSClient, __version__; print(f'Version: {__v ### Dependency Test ✅ ```bash -$ pip show wikijs-python-sdk -Name: wikijs-python-sdk +$ pip show py-wikijs +Name: py-wikijs Version: 0.1.0 Requires: pydantic, requests, typing-extensions Required-by: @@ -149,7 +149,7 @@ Required-by: | Attribute | Value | |-----------|-------| -| **Package Name** | `wikijs-python-sdk` | +| **Package Name** | `py-wikijs` | | **Import Name** | `wikijs` | | **Version** | 0.1.0 | | **Python Support** | 3.8+ | @@ -240,7 +240,7 @@ Required-by: ## 📦 PyPI vs Gitea-Only ### PyPI Benefits -- ✅ Simple installation: `pip install wikijs-python-sdk` +- ✅ Simple installation: `pip install py-wikijs` - ✅ Better discoverability - ✅ Automatic dependency resolution - ✅ Version management diff --git a/README.md b/README.md index 5a3f2a8..b81c082 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,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) [![Wiki.js Support](https://img.shields.io/badge/Wiki.js-2.2+-green.svg)](https://docs.requarks.io/releases) -[![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) +[![PyPI Package](https://img.shields.io/badge/PyPI-py--wikijs-blue.svg)](https://pypi.org/project/py-wikijs/) +[![GitHub](https://img.shields.io/badge/GitHub-l3ocho/py--wikijs-blue.svg)](https://github.com/l3ocho/py-wikijs) **A professional Python SDK for Wiki.js API integration.** @@ -18,13 +18,16 @@ ### Installation ```bash -# Install directly from Gitea -pip install git+https://gitea.hotserv.cloud/lmiranda/py-wikijs.git +# Install from PyPI (recommended) +pip install py-wikijs -# Or clone and install locally -git clone https://gitea.hotserv.cloud/lmiranda/py-wikijs.git -cd wikijs-python-sdk -pip install -e . +# Or install from GitHub +pip install git+https://github.com/l3ocho/py-wikijs.git + +# Or clone and install locally for development +git clone https://github.com/l3ocho/py-wikijs.git +cd py-wikijs +pip install -e ".[dev]" ``` ### Basic Usage @@ -138,8 +141,8 @@ Additional development tools: ### Local Development ```bash # Clone and setup -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 pip install -e ".[dev]" # Run tests diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 9a2258f..3223d0c 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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). \ No newline at end of file +**Questions?** Don't hesitate to create an issue in the [Gitea repository](https://github.com/l3ocho/py-wikijs/issues). \ No newline at end of file diff --git a/docs/GOVERNANCE.md b/docs/GOVERNANCE.md index bf11632..1be3954 100644 --- a/docs/GOVERNANCE.md +++ b/docs/GOVERNANCE.md @@ -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 diff --git a/docs/RISK_MANAGEMENT.md b/docs/RISK_MANAGEMENT.md index 819a88c..33ae0a0 100644 --- a/docs/RISK_MANAGEMENT.md +++ b/docs/RISK_MANAGEMENT.md @@ -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 diff --git a/docs/async_usage.md b/docs/async_usage.md index 9af43eb..723e12e 100644 --- a/docs/async_usage.md +++ b/docs/async_usage.md @@ -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 diff --git a/docs/compatibility.md b/docs/compatibility.md index 7cff8e0..b7c321c 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -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). diff --git a/docs/deployment.md b/docs/deployment.md index fe57805..1447954 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -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 diff --git a/docs/development.md b/docs/development.md index 9bbd589..aba0441 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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 diff --git a/docs/plans/IMPROVEMENT_PLAN_2.md b/docs/plans/IMPROVEMENT_PLAN_2.md index 91ea9cc..46439f1 100644 --- a/docs/plans/IMPROVEMENT_PLAN_2.md +++ b/docs/plans/IMPROVEMENT_PLAN_2.md @@ -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 --- diff --git a/docs/user_guide.md b/docs/user_guide.md index 6629176..7a153be 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -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 diff --git a/docs/users_api.md b/docs/users_api.md index b57dd12..c78bd62 100644 --- a/docs/users_api.md +++ b/docs/users_api.md @@ -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) diff --git a/docs/wikijs_sdk_architecture.md b/docs/wikijs_sdk_architecture.md index 61da29b..cd4020e 100644 --- a/docs/wikijs_sdk_architecture.md +++ b/docs/wikijs_sdk_architecture.md @@ -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 diff --git a/docs/wikijs_sdk_release_plan.md b/docs/wikijs_sdk_release_plan.md index c170417..97384b9 100644 --- a/docs/wikijs_sdk_release_plan.md +++ b/docs/wikijs_sdk_release_plan.md @@ -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 diff --git a/examples/README.md b/examples/README.md index 7cc9497..4310209 100644 --- a/examples/README.md +++ b/examples/README.md @@ -43,8 +43,8 @@ python examples/content_management.py 1. **Set up your environment:** ```bash # Clone the repository - git clone https://github.com/yourusername/wikijs-python-sdk - cd wikijs-python-sdk + git clone https://github.com/yourusername/py-wikijs + cd py-wikijs # Install the SDK pip install -e . diff --git a/examples/async_basic_usage.py b/examples/async_basic_usage.py index 6c33b8d..115d7d8 100644 --- a/examples/async_basic_usage.py +++ b/examples/async_basic_usage.py @@ -4,7 +4,7 @@ This example demonstrates how to use the AsyncWikiJSClient for high-performance concurrent operations with Wiki.js. Requirements: - pip install wikijs-python-sdk[async] + pip install py-wikijs[async] """ import asyncio diff --git a/examples/content_management.py b/examples/content_management.py index b5ee525..e6e8bee 100644 --- a/examples/content_management.py +++ b/examples/content_management.py @@ -357,7 +357,7 @@ def main(): project_page = PageCreate( title="Wiki.js Python SDK - Project Documentation", - path="projects/wikijs-python-sdk", + path="projects/py-wikijs", content=project_content, tags=["project", "sdk", "python", "documentation"], description="Project documentation for the Wiki.js Python SDK" diff --git a/examples/users_async.py b/examples/users_async.py index 62bacfe..ae761aa 100644 --- a/examples/users_async.py +++ b/examples/users_async.py @@ -1,4 +1,4 @@ -"""Async users management example for wikijs-python-sdk. +"""Async users management example for py-wikijs. This example demonstrates: - Async user operations diff --git a/examples/users_basic.py b/examples/users_basic.py index 7c498aa..26d1971 100644 --- a/examples/users_basic.py +++ b/examples/users_basic.py @@ -1,4 +1,4 @@ -"""Basic users management example for wikijs-python-sdk. +"""Basic users management example for py-wikijs. This example demonstrates: - Creating users diff --git a/pyproject.toml b/pyproject.toml index ff8e5b6..c0ab1f6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=61.0", "wheel"] build-backend = "setuptools.build_meta" [project] -name = "wikijs-python-sdk" +name = "py-wikijs" description = "A professional Python SDK for Wiki.js API integration" authors = [{name = "leomiranda", email = "lmiranda@hotserv.cloud"}] license = {text = "MIT"} @@ -60,11 +60,11 @@ all = [ ] [project.urls] -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" -Compatibility = "https://gitea.hotserv.cloud/lmiranda/py-wikijs/src/branch/main/docs/compatibility.md" +Homepage = "https://github.com/l3ocho/py-wikijs" +"Bug Reports" = "https://github.com/l3ocho/py-wikijs/issues" +Source = "https://github.com/l3ocho/py-wikijs" +Documentation = "https://github.com/l3ocho/py-wikijs/blob/main/docs" +Compatibility = "https://github.com/l3ocho/py-wikijs/blob/main/docs/compatibility.md" "Wiki.js" = "https://js.wiki" [tool.setuptools.dynamic] diff --git a/setup.py b/setup.py index 7f89f45..608bb18 100644 --- a/setup.py +++ b/setup.py @@ -42,19 +42,19 @@ def read_dev_requirements(): setup( - name="wikijs-python-sdk", + name="py-wikijs", version=read_version(), description="A professional Python SDK for Wiki.js API integration", long_description=read_readme(), long_description_content_type="text/markdown", author="leomiranda", author_email="lmiranda@hotserv.cloud", - url="https://gitea.hotserv.cloud/lmiranda/py-wikijs", + url="https://github.com/l3ocho/py-wikijs", project_urls={ - "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", - "Compatibility": "https://gitea.hotserv.cloud/lmiranda/py-wikijs/src/branch/main/docs/compatibility.md", + "Bug Reports": "https://github.com/l3ocho/py-wikijs/issues", + "Source": "https://github.com/l3ocho/py-wikijs", + "Documentation": "https://github.com/l3ocho/py-wikijs/blob/main/docs", + "Compatibility": "https://github.com/l3ocho/py-wikijs/blob/main/docs/compatibility.md", "Wiki.js": "https://js.wiki", }, packages=find_packages(), diff --git a/tests/__init__.py b/tests/__init__.py index 698e067..5fa171a 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -1 +1 @@ -"""Tests for wikijs-python-sdk.""" +"""Tests for py-wikijs.""" diff --git a/tests/aio/test_async_client.py b/tests/aio/test_async_client.py index cc62e3f..efdf026 100644 --- a/tests/aio/test_async_client.py +++ b/tests/aio/test_async_client.py @@ -28,7 +28,7 @@ class TestAsyncWikiJSClientInit: assert isinstance(client._auth_handler, APIKeyAuth) assert client.timeout == 30 assert client.verify_ssl is True - assert "wikijs-python-sdk" in client.user_agent + assert "py-wikijs" in client.user_agent def test_init_with_auth_handler(self): """Test initialization with auth handler.""" @@ -265,7 +265,7 @@ class TestAsyncWikiJSClientSessionCreation: session = client._create_session() assert isinstance(session, aiohttp.ClientSession) - assert "wikijs-python-sdk" in session.headers["User-Agent"] + assert "py-wikijs" in session.headers["User-Agent"] assert session.headers["Accept"] == "application/json" assert session.headers["Content-Type"] == "application/json" diff --git a/tests/auth/__init__.py b/tests/auth/__init__.py index 51abb85..66dce34 100644 --- a/tests/auth/__init__.py +++ b/tests/auth/__init__.py @@ -1 +1 @@ -"""Authentication tests for wikijs-python-sdk.""" +"""Authentication tests for py-wikijs.""" diff --git a/tests/conftest.py b/tests/conftest.py index 439cdd2..0502efc 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,4 +1,4 @@ -"""Test configuration and fixtures for wikijs-python-sdk.""" +"""Test configuration and fixtures for py-wikijs.""" import pytest import responses diff --git a/tests/test_client.py b/tests/test_client.py index 9a1fcaa..480c4dc 100644 --- a/tests/test_client.py +++ b/tests/test_client.py @@ -28,7 +28,7 @@ class TestWikiJSClientInit: assert isinstance(client._auth_handler, APIKeyAuth) assert client.timeout == 30 assert client.verify_ssl is True - assert "wikijs-python-sdk" in client.user_agent + assert "py-wikijs" in client.user_agent def test_init_with_auth_handler(self): """Test initialization with auth handler.""" diff --git a/wikijs/__init__.py b/wikijs/__init__.py index e67d172..94b5a08 100644 --- a/wikijs/__init__.py +++ b/wikijs/__init__.py @@ -82,7 +82,7 @@ __author__ = "Wiki.js SDK Contributors" __email__ = "" __license__ = "MIT" __description__ = "Professional Python SDK for Wiki.js API integration" -__url__ = "https://github.com/yourusername/wikijs-python-sdk" +__url__ = "https://github.com/yourusername/py-wikijs" # For type checking __all__ += [ diff --git a/wikijs/aio/client.py b/wikijs/aio/client.py index eb4210f..bdc4ebb 100644 --- a/wikijs/aio/client.py +++ b/wikijs/aio/client.py @@ -1,4 +1,4 @@ -"""Async WikiJS client for wikijs-python-sdk.""" +"""Async WikiJS client for py-wikijs.""" import json from typing import Any, Dict, Optional, Union @@ -8,7 +8,7 @@ try: except ImportError: raise ImportError( "aiohttp is required for async support. " - "Install it with: pip install wikijs-python-sdk[async]" + "Install it with: pip install py-wikijs[async]" ) from ..auth import APIKeyAuth, AuthHandler @@ -99,7 +99,7 @@ class AsyncWikiJSClient: # Request configuration self.timeout = timeout self.verify_ssl = verify_ssl - self.user_agent = user_agent or f"wikijs-python-sdk/{__version__}" + self.user_agent = user_agent or f"py-wikijs/{__version__}" # Endpoint handlers (will be initialized when session is created) self.pages = AsyncPagesEndpoint(self) diff --git a/wikijs/aio/endpoints/base.py b/wikijs/aio/endpoints/base.py index 2c1e05c..da0bd7d 100644 --- a/wikijs/aio/endpoints/base.py +++ b/wikijs/aio/endpoints/base.py @@ -1,4 +1,4 @@ -"""Base async endpoint class for wikijs-python-sdk.""" +"""Base async endpoint class for py-wikijs.""" from typing import TYPE_CHECKING, Any, Dict, Optional diff --git a/wikijs/aio/endpoints/pages.py b/wikijs/aio/endpoints/pages.py index 9fcd339..667c82f 100644 --- a/wikijs/aio/endpoints/pages.py +++ b/wikijs/aio/endpoints/pages.py @@ -1,4 +1,4 @@ -"""Async Pages API endpoint for wikijs-python-sdk.""" +"""Async Pages API endpoint for py-wikijs.""" from typing import Any, Dict, List, Optional, Union diff --git a/wikijs/aio/endpoints/users.py b/wikijs/aio/endpoints/users.py index d8e1948..5d8a67e 100644 --- a/wikijs/aio/endpoints/users.py +++ b/wikijs/aio/endpoints/users.py @@ -1,4 +1,4 @@ -"""Async Users API endpoint for wikijs-python-sdk.""" +"""Async Users API endpoint for py-wikijs.""" from typing import Any, Dict, List, Optional, Union diff --git a/wikijs/auth/__init__.py b/wikijs/auth/__init__.py index f5a4777..6106c03 100644 --- a/wikijs/auth/__init__.py +++ b/wikijs/auth/__init__.py @@ -1,4 +1,4 @@ -"""Authentication module for wikijs-python-sdk. +"""Authentication module for py-wikijs. This module contains authentication handlers for different authentication methods supported by Wiki.js. diff --git a/wikijs/auth/api_key.py b/wikijs/auth/api_key.py index c159d0a..e02f47e 100644 --- a/wikijs/auth/api_key.py +++ b/wikijs/auth/api_key.py @@ -1,4 +1,4 @@ -"""API key authentication for wikijs-python-sdk. +"""API key authentication for py-wikijs. This module implements API key authentication for Wiki.js instances. API keys are typically used for server-to-server authentication. diff --git a/wikijs/auth/base.py b/wikijs/auth/base.py index fd85469..19c5c38 100644 --- a/wikijs/auth/base.py +++ b/wikijs/auth/base.py @@ -1,4 +1,4 @@ -"""Base authentication interface for wikijs-python-sdk. +"""Base authentication interface for py-wikijs. This module defines the abstract base class for all authentication handlers, providing a consistent interface for different authentication methods. diff --git a/wikijs/auth/jwt.py b/wikijs/auth/jwt.py index e9fc17f..bab2638 100644 --- a/wikijs/auth/jwt.py +++ b/wikijs/auth/jwt.py @@ -1,4 +1,4 @@ -"""JWT token authentication for wikijs-python-sdk. +"""JWT token authentication for py-wikijs. This module implements JWT (JSON Web Token) authentication for Wiki.js instances. JWT tokens are typically used for user-based authentication and have expiration times. diff --git a/wikijs/cache/__init__.py b/wikijs/cache/__init__.py index 052d13d..014a8ee 100644 --- a/wikijs/cache/__init__.py +++ b/wikijs/cache/__init__.py @@ -1,4 +1,4 @@ -"""Caching module for wikijs-python-sdk. +"""Caching module for py-wikijs. This module provides intelligent caching for frequently accessed Wiki.js resources like pages, users, and groups. It supports multiple cache backends and TTL-based diff --git a/wikijs/cache/base.py b/wikijs/cache/base.py index b2a7ab4..93a7144 100644 --- a/wikijs/cache/base.py +++ b/wikijs/cache/base.py @@ -1,4 +1,4 @@ -"""Base cache interface for wikijs-python-sdk.""" +"""Base cache interface for py-wikijs.""" from abc import ABC, abstractmethod from dataclasses import dataclass diff --git a/wikijs/cache/memory.py b/wikijs/cache/memory.py index e2d90f2..8e13521 100644 --- a/wikijs/cache/memory.py +++ b/wikijs/cache/memory.py @@ -1,4 +1,4 @@ -"""In-memory cache implementation for wikijs-python-sdk.""" +"""In-memory cache implementation for py-wikijs.""" import time from collections import OrderedDict diff --git a/wikijs/client.py b/wikijs/client.py index 67af338..8ef4be2 100644 --- a/wikijs/client.py +++ b/wikijs/client.py @@ -1,4 +1,4 @@ -"""Main WikiJS client for wikijs-python-sdk.""" +"""Main WikiJS client for py-wikijs.""" import json from typing import Any, Dict, Optional, Union @@ -95,7 +95,7 @@ class WikiJSClient: # Request configuration self.timeout = timeout self.verify_ssl = verify_ssl - self.user_agent = user_agent or f"wikijs-python-sdk/{__version__}" + self.user_agent = user_agent or f"py-wikijs/{__version__}" # Cache configuration self.cache = cache diff --git a/wikijs/endpoints/__init__.py b/wikijs/endpoints/__init__.py index bbf015a..1159548 100644 --- a/wikijs/endpoints/__init__.py +++ b/wikijs/endpoints/__init__.py @@ -1,4 +1,4 @@ -"""API endpoints module for wikijs-python-sdk. +"""API endpoints module for py-wikijs. This module contains endpoint handlers for different Wiki.js API endpoints. diff --git a/wikijs/endpoints/base.py b/wikijs/endpoints/base.py index 5fd6296..18abc37 100644 --- a/wikijs/endpoints/base.py +++ b/wikijs/endpoints/base.py @@ -1,4 +1,4 @@ -"""Base endpoint class for wikijs-python-sdk.""" +"""Base endpoint class for py-wikijs.""" from typing import TYPE_CHECKING, Any, Dict, Optional diff --git a/wikijs/endpoints/pages.py b/wikijs/endpoints/pages.py index f6e41fa..669d9fa 100644 --- a/wikijs/endpoints/pages.py +++ b/wikijs/endpoints/pages.py @@ -1,4 +1,4 @@ -"""Pages API endpoint for wikijs-python-sdk.""" +"""Pages API endpoint for py-wikijs.""" from typing import Any, Dict, List, Optional, Union diff --git a/wikijs/endpoints/users.py b/wikijs/endpoints/users.py index 113d534..3f2791a 100644 --- a/wikijs/endpoints/users.py +++ b/wikijs/endpoints/users.py @@ -1,4 +1,4 @@ -"""Users API endpoint for wikijs-python-sdk.""" +"""Users API endpoint for py-wikijs.""" from typing import Any, Dict, List, Optional, Union diff --git a/wikijs/exceptions.py b/wikijs/exceptions.py index e383f4b..33c6cbf 100644 --- a/wikijs/exceptions.py +++ b/wikijs/exceptions.py @@ -1,4 +1,4 @@ -"""Exception hierarchy for wikijs-python-sdk.""" +"""Exception hierarchy for py-wikijs.""" from typing import Any, Dict, Optional diff --git a/wikijs/models/__init__.py b/wikijs/models/__init__.py index f42bef1..3d17947 100644 --- a/wikijs/models/__init__.py +++ b/wikijs/models/__init__.py @@ -1,4 +1,4 @@ -"""Data models for wikijs-python-sdk.""" +"""Data models for py-wikijs.""" from .asset import ( Asset, diff --git a/wikijs/models/base.py b/wikijs/models/base.py index 678e471..c658798 100644 --- a/wikijs/models/base.py +++ b/wikijs/models/base.py @@ -1,4 +1,4 @@ -"""Base model functionality for wikijs-python-sdk.""" +"""Base model functionality for py-wikijs.""" from datetime import datetime from typing import Any, Dict, Optional diff --git a/wikijs/models/page.py b/wikijs/models/page.py index e626bf8..8a28f1b 100644 --- a/wikijs/models/page.py +++ b/wikijs/models/page.py @@ -1,4 +1,4 @@ -"""Page-related data models for wikijs-python-sdk.""" +"""Page-related data models for py-wikijs.""" import re from typing import List, Optional diff --git a/wikijs/models/user.py b/wikijs/models/user.py index 96ee627..e12879f 100644 --- a/wikijs/models/user.py +++ b/wikijs/models/user.py @@ -1,4 +1,4 @@ -"""User-related data models for wikijs-python-sdk.""" +"""User-related data models for py-wikijs.""" import re from typing import List, Optional diff --git a/wikijs/utils/__init__.py b/wikijs/utils/__init__.py index 621665b..e8ff56a 100644 --- a/wikijs/utils/__init__.py +++ b/wikijs/utils/__init__.py @@ -1,4 +1,4 @@ -"""Utility functions for wikijs-python-sdk.""" +"""Utility functions for py-wikijs.""" from .helpers import ( build_api_url, diff --git a/wikijs/utils/helpers.py b/wikijs/utils/helpers.py index 3bdd69c..8970c97 100644 --- a/wikijs/utils/helpers.py +++ b/wikijs/utils/helpers.py @@ -1,4 +1,4 @@ -"""Helper utilities for wikijs-python-sdk.""" +"""Helper utilities for py-wikijs.""" import re from typing import Any, Dict diff --git a/wikijs/version.py b/wikijs/version.py index 3234af5..e7a8b23 100644 --- a/wikijs/version.py +++ b/wikijs/version.py @@ -1,4 +1,4 @@ -"""Version information for wikijs-python-sdk.""" +"""Version information for py-wikijs.""" __version__ = "0.1.0" __version_info__ = (0, 1, 0)