diff --git a/.gitignore b/.gitignore index 3883e04..bee8a64 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1 @@ __pycache__ -.mypy_cache diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 379270c..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2023 Edward Betts - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md deleted file mode 100644 index 4fa86ca..0000000 --- a/README.md +++ /dev/null @@ -1,91 +0,0 @@ -# Wikipedia Disambiguation Link Fixer - -This Flask web application is designed to help fix disambiguation links in -Wikipedia articles. It makes use of various Python modules, including Flask, -SQLAlchemy, lxml, and Jinja2, to provide a user-friendly interface for editing -and saving changes to Wikipedia articles. - -## Features - -- Retrieve a list of articles with disambiguation links from - [dplbot.toolforge.org](https://dplbot.toolforge.org/articles_with_dab_links.php). -- Edit Wikipedia articles directly within the app. -- Automatically generate edit summaries for your changes. -- OAuth integration for secure Wikipedia authentication. - -## Prerequisites - -Before you can run this application, ensure you have the following prerequisites -installed: - -- Python 3.x -- Flask -- SQLAlchemy -- lxml -- Jinja2 -- requests -- requests-oauthlib - -You'll also need to obtain OAuth credentials from Wikipedia to use the -authentication features. - -## Installation - -1. Clone this repository to your local machine: - - ``` - git clone https://git.4angle.com/edward/dab-mechanic.git - ``` - -2. Navigate to the project directory: - - ``` - cd dab-mechanic - ``` - -3. Install the required Python packages using pip: - - ``` - pip install -r requirements.txt - ``` - -4. Configure the application by modifying the `config.default` file with your - OAuth credentials and other settings. - -## Usage - -1. Start the Flask application: - - ``` - python3 web_view.py - ``` - -2. Access the app in your web browser at `http://localhost:5000`. - -3. Log in with your Wikipedia account using OAuth. - -4. Browse the list of articles with disambiguation links and make necessary - edits. - -5. Save your edits, and the application will update the Wikipedia articles - accordingly. - -## Contributing - -Contributions are welcome! If you'd like to improve this application or report -issues, please create a pull request or open an issue on the [Forgejo -repository](https://git.4angle.com/edward/dab-mechanic). - -## License - -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file -for details. - -## Acknowledgments - -- This application was developed by Edward Betts. - -## Contact - -If you have any questions or need assistance, -you can contact Edward Betts at edward@4angle.com