Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fastily/mtc-api
🌟 Generates description pages for files to be transferred to Commons
https://github.com/fastily/mtc-api
wikimedia-commons wikimedia-tools wikipedia
Last synced: 30 days ago
JSON representation
🌟 Generates description pages for files to be transferred to Commons
- Host: GitHub
- URL: https://github.com/fastily/mtc-api
- Owner: fastily
- License: gpl-3.0
- Created: 2024-04-09T22:51:33.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-10T03:52:03.000Z (5 months ago)
- Last Synced: 2024-08-10T04:40:41.529Z (4 months ago)
- Topics: wikimedia-commons, wikimedia-tools, wikipedia
- Language: Python
- Homepage: https://mtc-api.toolforge.org
- Size: 24.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# mtc-api
[](https://www.python.org)
[](https://www.mediawiki.org/wiki/MediaWiki)
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
mtc-api is an API that assists with file imports from Wikipedia to Commons. It provides a simple interface web service API that can batch generate description pages and new titles for transfer candinates.
👉 This API does not perform the actual transfers, it is only able to generate description pages and new titles.
## Usage
### POST `/generate`
Takes a list of titles of files on enwp and attempts to generate file description pages and a title for each file for when the file is transferred to Commons. This route by default also filters files which may not be appropriate for Commons. This functionality can optionally be disabled by passing the key-value pair `force: true` at the top level of the payload JSON.
#### Basic Example
Body
```json
{
"titles": [
"File:Diarmuid Lynch.jpg",
"File:DFO dog stare.JPG"
]
}
```
Response
```json
{
"fails": [
"File:Diarmuid Lynch.jpg"
],
"generated_text": [
{
"com_title": "File:DFO dog stare.JPG",
"desc": "== {{int:filedesc}} ==\n{{Information\n|description=for use in my user space.\n|date=\n|source=\n|author=\n|permission=\n|other versions=\n}}\n\n== {{int:license-header}} ==\n{{Cc-by-sa-4.0}}\n{{Own}}\n\n== {{Original upload log}} ==\n{{Original file page|en.wikipedia|DFO dog stare.JPG}}\n{| class=\"wikitable\"\n! {{int:filehist-datetime}} !! {{int:filehist-dimensions}} !! {{int:filehist-user}} !! {{int:filehist-comment}}\n|-\n| 2020-11-01 18:04:48 || 4000 × 6000 || [[w:User:Deepfriedokra|Deepfriedokra]] || ''{{own work}} for use in my user space.''\n|}",
"enwp_title": "File:DFO dog stare.JPG"
}
]
}
```
#### Filter Disabled Example
Body
```json
{
"titles": [
"File:FleetwoodLeyland.jpg",
"File:DFO dog stare.JPG"
],
"force": true
}
```
Response
```json
{
"fails": [],
"generated_text": [
{
"com_title": "File:FleetwoodLeyland.jpg",
"desc": "== {{int:filedesc}} ==\n{{Information\n|description=Fleetwood-Smith (second from right) has England batsman [[w:Maurice Leyland]] caught at slip by [[w:Arthur Chipperfield]], one of his ten wickets in the fourth Test at [[w:Adelaide Oval]] - from the 1936-37 cricket series between Australia and England.\n|date=c. 1936-7\n|source=\n|author=\n|permission=Image is pre-1955 and therefore in the Public Domain.\n|other versions=\n}}\n\n== {{int:license-header}} ==\n{{PD-URAA|pdsource=yes}}\n{{PD-Australia|1=commons}}\n\n== {{Original upload log}} ==\n{{Original file page|en.wikipedia|FleetwoodLeyland.jpg}}\n{| class=\"wikitable\"\n! {{int:filehist-datetime}} !! {{int:filehist-dimensions}} !! {{int:filehist-user}} !! {{int:filehist-comment}}\n|-\n| 2007-12-17 07:14:40 || 252 × 472 || [[w:User:Phanto282|Phanto282]] || ''Pic fromt the 1936-37 cricket series between Australia and England. Image is pre-1955 and therefore in the Public Domain. {{Template:PD-Australia}}''\n|}",
"enwp_title": "File:FleetwoodLeyland.jpg"
},
{
"com_title": "File:DFO dog stare.JPG",
"desc": "== {{int:filedesc}} ==\n{{Information\n|description=for use in my user space.\n|date=\n|source=\n|author=\n|permission=\n|other versions=\n}}\n\n== {{int:license-header}} ==\n{{Cc-by-sa-4.0}}\n{{Own}}\n\n== {{Original upload log}} ==\n{{Original file page|en.wikipedia|DFO dog stare.JPG}}\n{| class=\"wikitable\"\n! {{int:filehist-datetime}} !! {{int:filehist-dimensions}} !! {{int:filehist-user}} !! {{int:filehist-comment}}\n|-\n| 2020-11-01 18:04:48 || 4000 × 6000 || [[w:User:Deepfriedokra|Deepfriedokra]] || ''{{own work}} for use in my user space.''\n|}",
"enwp_title": "File:DFO dog stare.JPG"
}
]
}
```
## Useful commands
```bash
# start development server
python -m mtc_api
# use gunicorn to run in prod
gunicorn -w 2 -k uvicorn.workers.UvicornWorker -b "0.0.0.0:8000" mtc_api.__main__:app
```