blitzwing/wikimore
1
0
Fork 0
forked from PrivateCoffee/wikimore
Code Pull requests Activity
No description
42 commits 2 branches 5 tags 388 KiB
Python 48.1%
CSS 46.3%
HTML 5.6%
Find a file
Kumi a4a9cbbdb3
feat: add type annotations and docstrings to API routes 
Enhanced the code by adding type annotations and comprehensive
docstrings for better clarity and maintainability. The changes
include detailed explanations of return types and parameters for
all major functions and routes in the application. Additionally,
reordered imports for better readability and added a new typing
import to support the annotations.

These improvements facilitate easier understanding and usage of
the codebase, align with best practices, and provide hints for
static type checkers, leading to fewer runtime errors.
2024-08-19 17:28:29 +02:00
.forgejo/workflows feat: add CI/CD workflow for publishing Python package 2024-07-16 10:08:07 +02:00
.vscode refactor: restructure project for PyPI packaging 2024-07-16 09:58:18 +02:00
src/wikimore feat: add type annotations and docstrings to API routes 2024-08-19 17:28:29 +02:00
.gitignore chore: update .gitignore to include /dist/ directory 2024-07-16 09:59:11 +02:00
LICENSE feat: initial setup of Wikimore Flask app with basic features 2024-07-11 12:25:19 +02:00
pyproject.toml chore(release): bump version to 0.1.3 2024-08-18 15:55:47 +02:00
README.md refactor: restructure project for PyPI packaging 2024-07-16 09:58:18 +02:00
requirements-dev.txt chore: update dependencies management for development 2024-08-17 08:26:25 +02:00

README.md

Wikimore - A simple frontend for Wikimedia projects

Support Private.coffee! Matrix PyPI PyPI - Python Version PyPI - License Latest Git Commit

Wikimore is a simple frontend for Wikimedia projects. It uses the MediaWiki API to fetch data from Wikimedia projects and display it in a user-friendly way. It is built using Flask.

This project is still in development and more features will be added in the future. It is useful for anyone who wants to access Wikimedia projects with a more basic frontend, or to provide access to Wikimedia projects to users who cannot access them directly, for example due to state censorship.

Features

  • Supports all Wikimedia projects in all languages
  • Search functionality
  • Proxy support for Wikimedia images

Instances

URL Provided by Country Comments
wikimore.private.coffee Private.coffee Austria

If you operate a public instance of Wikimore and would like to have it listed here, please open an issue or a pull request.

Installation

Production

  1. Create a virtual environment and activate it
python3 -m venv venv
source venv/bin/activate
  1. Install the package from PyPI
pip install wikimore
  1. Run the application
wikimore
  1. Open your browser and navigate to http://localhost:8109

Development

  1. Clone the repository
git clone https://git.private.coffee/privatecoffee/wikimore.git
cd wikimore
  1. Create a virtual environment and activate it
python3 -m venv venv
source venv/bin/activate
  1. Install the package in editable mode
pip install -e .
  1. Run the application
flask --app wikimore run
  1. Open your browser and navigate to http://localhost:5000

License

This project is licensed under the MIT License - see the LICENSE file for details.