MediaWikiServerTools 0.0.1__tar.gz

mediawikiservertools-0.0.1/.github/workflows/build.yml

@@ -0,0 +1,37 @@
+ # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Build
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.10"]
+        #os: [ubuntu-latest, macos-latest, windows-latest]
+        #python-version: [ '3.10', '3.11', '3.12', '3.13' ]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install pip
+      run: |
+        python -m pip install --upgrade pip
+    - name: Install dependencies
+      run: |
+        scripts/install
+    - name: Run tests
+      run: |
+        scripts/test

mediawikiservertools-0.0.1/.github/workflows/upload-to-pypi.yml

@@ -0,0 +1,27 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+    - name: Build and publish
+      run: |
+        hatch build
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

mediawikiservertools-0.0.1/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

mediawikiservertools-0.0.1/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>MediaWikiServerTools</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.python.pydev.PyDevBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.python.pydev.pythonNature</nature>
+	</natures>
+</projectDescription>

mediawikiservertools-0.0.1/.pydevproject

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<?eclipse-pydev version="1.0"?><pydev_project>
+    <pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Default</pydev_property>
+    <pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python interpreter</pydev_property>
+    <pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
+        <path>/${PROJECT_DIR_NAME}</path>
+    </pydev_pathproperty>
+</pydev_project>

mediawikiservertools-0.0.1/AGENTS.md

@@ -0,0 +1,234 @@
+# AGENTS.md - Agent Coding Guidelines for MediaWikiServerTools
+
+This file provides guidelines for agentic coding agents working on this repository.
+
+## Important Rules
+
+**CRITICAL: NEVER EVER DO ANY ACTION READING, MODIFYING OR RUNNING without explaing the plan
+Each set of intended actions needs to be explained in the format:
+I understood that <YOUR ANALYSIS> so that i plan to <GOALS YOU PURSUE> by <ACTIONS TO BE CONFIRMED> confirm with go!
+YOU WILL NEVER PROCEED WITH OUT POSITIVE CONFIRMATION by go!
+
+## Project Overview
+
+MediaWikiServerTools is a Python-based MediaWiki Server Management System frontend.  It allows local and
+remote manipulation of servers with partial docker support
+It consists of:
+- `backend/` - Server and backup functionality
+- `tests/` - Unit tests using unittest
+
+Requires Python 3.10+.
+
+---
+
+## Build, Lint, and Test Commands
+
+### Installation
+```bash
+pip install -e .
+# or: scripts/install
+```
+
+### Running Tests
+
+**Run all tests with unittest discover (default):**
+```bash
+python3 -m unittest discover
+# or: scripts/test
+```
+
+**Run tests with green:**
+```bash
+scripts/test -g
+# or: green tests -s 1
+```
+
+**Run tests module-by-module:**
+```bash
+scripts/test -m
+```
+
+**Run tests with tox:**
+```bash
+scripts/test -t
+```
+
+**Run a single test file:**
+```bash
+python -m unittest tests/test_wikicms.py
+```
+
+**Run a specific test method:**
+```bash
+python -m unittest tests.test_wikicms.TestWikiCMS.testWikiCMS
+```
+
+### Code Formatting
+
+**Format and sort imports:**
+```bash
+scripts/blackisort
+```
+This runs `isort` then `black` on `tests/` and `backend/` directories.
+
+### Running the Application
+
+** CLI commands:**
+```bash
+tsite   # backend/tsite:main
+sqlbackup  # backend/sql_backup:main
+cronbackup # backend.cron_backup:main
+```
+
+---
+
+## Code Style Guidelines
+
+### Imports
+
+Order imports as follows (enforced by isort):
+1. Standard library
+2. Third-party packages
+3. Local application imports
+
+Use relative imports within the project:
+```python
+from backend.site import FrontendSite
+```
+
+### Formatting
+
+- **Line length**: Follow black's default (88 characters)
+- **Strings**: Use f-strings for string interpolation
+- **Indentation**: 4 spaces (no tabs)
+
+### Type Hints
+
+Use type hints for function signatures and variables:
+```python
+def getContent(self, pagePath: str) -> tuple[str, Optional[str], Optional[str]]:
+    # ...
+```
+
+Common types used: `str`, `int`, `bool`, `List`, `Dict`, `Optional`, `Any`
+
+### Naming Conventions
+
+- **Classes**: `PascalCase` (e.g., `WikiFrontend`, `Site`)
+- **Functions/methods**: `snake_case` (e.g., `get_content()`, `fix_images_and_videos()`)
+- **Variables**: `snake_case` (e.g., `page_title`, `filter_keys`)
+- **Constants**: `UPPER_SNAKE_CASE` (e.g., `DEFAULT_TIMEOUT`)
+- **Private methods**: prefix with underscore (e.g., `_resolve_ip()`)
+
+### Docstrings
+
+Use docstrings for all public classes and functions:
+```python
+def extract_site_and_path(path: str):
+    """
+    Splits the given path into the site component and the remaining path.
+
+    Parameters:
+        path (str): The complete path to split.
+
+    Returns:
+        tuple: A tuple where the first element is the site and the second
+               element is the subsequent path.
+    """
+```
+
+### Error Handling
+
+- Use try/except blocks with specific exception types when possible
+- Include meaningful error messages
+- Example pattern from codebase:
+```python
+try:
+    content = self.wiki.getHtml(pageTitle)
+except Exception as e:
+    error = self.errMsg(e)
+```
+
+### Logging
+
+Use the logging module:
+```python
+import logging
+self.logger = logging.getLogger(self.__class__.__name__)
+self.logger.debug("message")
+```
+
+### Class Structure
+
+- Classes should inherit from `object` or other base classes
+- Use dataclasses for simple data containers:
+```python
+from dataclasses import dataclass, field
+from typing import Optional
+
+@dataclass
+class Site:
+    name: str
+    container: Optional[str] = None
+    ip: str = field(default="?", init=False)
+```
+
+### Constants and Configuration
+
+- Store configuration in class attributes with type annotations
+- Use `field(default=..., init=False)` for computed/non-init fields
+
+### Testing
+
+- Test classes inherit from `Basetest` (from basemkit)
+- Test methods should start with `test_`
+- Use assertions: `self.assertTrue()`, `self.assertEqual()`
+- Debug output with `print()` using f-strings
+
+### File Organization
+
+```
+MediaWikiServerTools/
+├── backend/          # Server/backup code
+│   ├── __init__.py
+│   ├── site.py
+│   ├── sql_backup.py
+│   ├── cron_backup.py
+│   ├── wikibackup.py
+│   ├── remote.py
+│   ├── tsite.py
+│   └── server.py
+├── tests/            # Unit tests
+│   ├── test_wikicms.py
+│   └── ...
+├── scripts/          # Build/utility scripts
+│   ├── blackisort
+│   ├── test
+│   └── install
+└── pyproject.toml
+```
+
+### Dependencies
+
+Key dependencies (see pyproject.toml):
+- `pybasemkit` - Base utilities
+- `py-3rdparty-mediawiki` - MediaWiki client
+- `beautifulsoup4` - HTML parsing
+- `lxml` - XML/HTML processing
+
+---
+
+## CI/CD
+
+GitHub Actions workflow: `.github/workflows/build.yml`
+- Runs on Python 3.10
+- Installs dependencies via `scripts/install`
+- Runs tests via `scripts/test`
+
+---
+
+## Additional Notes
+
+- Version is managed via hatchling in `backend/__init__.py`
+- Package uses flit/hatchling build system
+- Follow existing code patterns when extending functionality