{
    "info": {
        "author": "Pedro Buteri Gonring",
        "author_email": "pedro@bigode.net",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "|Downloads|\n\nmamescraper\n===========\n\nScrap mame games information and images from:\n\n- Bigode: 'http://mame.bigode.net/' (maintained by me) or\n- Arcade Database: 'http://adb.arcadeitalia.net/' (maintained by motoschifo)\n\nAnd generate a XML file for use with EmulationStation, the default frontend for RetroPie and Recalbox.\n\nSimple example of the scraper in action::\n\n    $ mamescraper\n\n    Initializing the scraper...\n\n    Scraping from: bigode - http://mame.bigode.net/\n\n    Mame database xml not found\n     Downloading: 100%\n    Done!\n\n    Generating list of images to download...\n    Done!\n\n    Downloading 10 images:\n     aliensyn.png downloaded\n     guwange.png downloaded\n     bjourney.png downloaded\n     ecofghtr.png downloaded\n     captcomm.png downloaded\n     spf2t.png downloaded\n     nbahangt.png downloaded\n     ldrun.png downloaded\n     raiden2.png downloaded\n     tmnt2.png downloaded\n    Done!\n\n    Generating new gamelist xml...\n     New gamelist.xml file created!\n\n    Total time spent: 0m 1s\n\n    All set! Happy gaming :)\n\n\nAbout\n=====\n\nThe purpose of this scraper is to be simple and fast. Currently it supports\ntwo sources with drastically different scraping methodologies.\n\nThe default source (bigode) is a lot faster because the scraper will download\nan entire mame database (1.1MB compressed) and scrap all the games information\nin one go. Besides that, this source uses a CDN and a very fast webserver to\nserve the images, resulting in faster responses and downloading speed overall.\n\nThe adb source is a more traditional approach, for each game found, the scraper\nwill do a http request to get the information needed and then will download the\nappropriate image.\n\nIt is important to note that the images flyers on 'bigode' source are smaller\nin size, because they have a fixed 400 width.\n\nTo illustrate the difference in scraping speed, the following shows the time\nspent scraping an entire mame 037b5 set (2241 roms) on both sources:\n\n'bigode' source::\n\n    Command: mamescraper -w 10 -i title\n    Time spent: 1m 10s\n\n'adb' source::\n\n    Command: mamescraper -w 10 -i title -s adb\n    Time spent: 8m 29s\n\nNote that mamescraper was run with 10 workers and scraping titles only. If ran\nin 'mixed' image mode (default) the difference is even higher, since images\nflyers are bigger on adb:\n\n'bigode' source::\n\n    Command: mamescraper -w 10\n    Time spent: 2m 2s\n\n\n'adb' source::\n\n    Command: mamescraper -w 10 -s adb\n    Time spent: 26m 47s\n\nBased on that, the recommended way is to run using the default 'bigode' source\nand if a game is not found, just run the scraper again in 'append' mode\n(to scan only the missing games) using 'adb' as source.\n\nA huge thanks for AntoPISA creator of `Progetto Snaps <http://www.progettosnaps.net/>`_\nfor the images and tons of mame resources.\n\nAlso, a huge thanks to Motoschifo creator of `Arcade Database <http://adb.arcadeitalia.net/>`_\nfor the awesome arcade database website.\n\n\nNotes\n=====\n\n- Works on Python 2.7 and Python 3.3+\n- Uses only Python standard library for maximum compatibility\n\n\nInstall\n=======\n\nInstall using pip::\n\n    pip install mamescraper\n\nor\n\nDownload and set executable permission on the script file::\n\n    chmod +x mamescraper.py\n\nor\n\nDownload and run using the python interpreter::\n\n    python mamescraper.py\n\nor\n\nDownload the Windows executable file from the `releases <https://github.com/pdrb/mamescraper/releases>`_ page.\n\n\nUsage\n=====\n\n::\n\n    Usage: mamescraper [options]\n\n    scrap mame games information and images from 'mame.bigode.net' or\n    'adb.arcadeitalia.net'\n\n    Options:\n    --version           show program's version number and exit\n    -h, --help          show this help message and exit\n    -a, --append        scrap only missing roms from output file and append it\n                        to the file (default: disabled)\n    -d ROMS_DIR         directory containing the games (default: current\n                        directory)\n    -e IMAGES_DIR_NAME  directory name to download the images (default: images)\n    -f FORMAT           file format of the games: 'zip' or '7z' (default: zip)\n    -i IMAGES           images type: 'mixed', 'title' or 'flyer' - mixed will\n                        download a flyer and fallback to title if a flyer is not\n                        found (default: mixed)\n    -o OUTPUT_FILE      the xml file that will be created (default:\n                        gamelist.xml)\n    -s SOURCE           information and images source: 'bigode' or 'adb'\n                        (default: bigode)\n    -w WORKERS          number of workers threads to use (default: 5)\n\n\nExamples\n========\n\nSimplest use case is to run on the mame games directory itself::\n\n    $ cd my_games_dir\n    $ mamescraper\n\nAlternatively, you can pass the directory to the scraper::\n\n    $ mamescraper -d path_to_games_dir\n\nScrap only missing games in the existing 'gamelist.xml' file::\n\n    $ mamescraper -a\n\nIt is useful for scrap on both sources if a game is not found. Just run the\nscraper a second time with append enable and a different source::\n\n    $ mamescraper\n    $ mamescraper -a -s adb\n\nIf you have games in mixed formats, the following will run the first time\nscraping games in 'zip' format (default) and the second time appending the\nmissing games in '7z' format::\n\n    $ mamescraper\n    $ mamescraper -a -f 7z\n\nRun with 10 workers downloading only titles images::\n\n    $ mamescraper -i title -w 10\n\n\n.. |Downloads| image:: https://pepy.tech/badge/mamescraper",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/pdrb/mamescraper",
        "keywords": "mame scraper games roms emulationstation retropie recalbox",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "mamescraper",
        "package_url": "https://pypi.org/project/mamescraper/",
        "platform": "",
        "project_url": "https://pypi.org/project/mamescraper/",
        "project_urls": {
            "Homepage": "https://github.com/pdrb/mamescraper"
        },
        "release_url": "https://pypi.org/project/mamescraper/0.4/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "scrap mame games information and images",
        "version": "0.4"
    },
    "last_serial": 4687058,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4c159ebd34871083165dd11ab31dfb14",
                    "sha256": "d08d4dbedbef473a5103fe5ab7e19cfdccbe0cd6e15c24b9b8dcc6161bd3d21e"
                },
                "downloads": -1,
                "filename": "mamescraper-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "4c159ebd34871083165dd11ab31dfb14",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8010,
                "upload_time": "2017-02-21T21:30:42",
                "url": "https://files.pythonhosted.org/packages/65/bd/b2c527374374e11e62b7b9a9738810a23fe5680b979f48656e3e4c5f9811/mamescraper-0.1.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3a3099ffc878710a86564c6511e341ec",
                    "sha256": "2cafdb4ed5c62c27457b1823e6571954efd4d64d6db87c319dc3b2f2941398bd"
                },
                "downloads": -1,
                "filename": "mamescraper-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "3a3099ffc878710a86564c6511e341ec",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8182,
                "upload_time": "2017-02-23T05:02:53",
                "url": "https://files.pythonhosted.org/packages/a2/0b/1585044b56bc49cbc9e0e227420bc8661a55b4d70304841e7570eb82c5e6/mamescraper-0.2.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "678a4ac993369d86cb41ff1a9e46ae77",
                    "sha256": "13d2bb73004315cca74df9fb7cf40819fcfe0cf48cd20d65518479efc1b1cf5b"
                },
                "downloads": -1,
                "filename": "mamescraper-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "678a4ac993369d86cb41ff1a9e46ae77",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8331,
                "upload_time": "2017-10-27T15:24:33",
                "url": "https://files.pythonhosted.org/packages/cb/cf/9a2e483f2322c4be9c108d7d5dbe7e335bd9ce955158398a918fed81d5a0/mamescraper-0.3.tar.gz"
            }
        ],
        "0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ec813bc86a1c21a318da9f740c01e8f0",
                    "sha256": "6ea8ce9b124d2de342b765d5d776477b2812302637c82415181504780c7cda5e"
                },
                "downloads": -1,
                "filename": "mamescraper-0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "ec813bc86a1c21a318da9f740c01e8f0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9362,
                "upload_time": "2019-01-11T21:36:54",
                "url": "https://files.pythonhosted.org/packages/f3/99/e9a3cd3d489700ae7e49b65a14189c3dc2cbfc65dcf8c1a47d00b72856bc/mamescraper-0.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ec813bc86a1c21a318da9f740c01e8f0",
                "sha256": "6ea8ce9b124d2de342b765d5d776477b2812302637c82415181504780c7cda5e"
            },
            "downloads": -1,
            "filename": "mamescraper-0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "ec813bc86a1c21a318da9f740c01e8f0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9362,
            "upload_time": "2019-01-11T21:36:54",
            "url": "https://files.pythonhosted.org/packages/f3/99/e9a3cd3d489700ae7e49b65a14189c3dc2cbfc65dcf8c1a47d00b72856bc/mamescraper-0.4.tar.gz"
        }
    ]
}