PrivateCoffee/wikimore
5
1
Fork 1
Code Issues 11 Pull requests Projects Releases Packages Wiki Activity Actions
wikimore/README.md
Kumi ae73156fc9
refactor: restructure project for PyPI packaging 
- Added `pyproject.toml` for project metadata and dependency management
- Moved application code to `src/wikimore` directory for better organization
- Updated `launch.json` configuration for Flask app
- Enhanced README with installation, development instructions, and badges
- Introduced `main` function in `app.py` for environment-based configuration

These changes streamline packaging and improve project maintainability.
2024-07-16 09:58:18 +02:00

2.8 KiB
Raw Permalink Blame History

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.