cbpickaxe


Namecbpickaxe JSON
Version 0.1.2 PyPI version JSON
download
home_page
SummaryA Python library and scripts for data mining the game Cassette Beasts.
upload_time2023-11-12 03:48:34
maintainer
docs_urlNone
authorExcaliburZero
requires_python>=3.11
licenseMIT License
keywords cassette beasts
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # cbpickaxe [![Python library](https://github.com/ExcaliburZero/cbpickaxe/actions/workflows/python-library.yml/badge.svg)](https://github.com/ExcaliburZero/cbpickaxe/actions/workflows/python-library.yml) [![Documentation Status](https://readthedocs.org/projects/cbpickaxe/badge/?version=latest)](https://cbpickaxe.readthedocs.io/en/latest/?badge=latest)
A Python library and set of scripts for data mining the game Cassette Beasts.

```python
import cbpickaxe as cbp

hoylake = cbp.Hoylake()
hoylake.load_root("cassette_beasts", "Cassette Beasts")

for monster_form in hoylake.load_monster_forms("res://data/monster_forms/").values():
    monster_name = hoylake.translate(monster_form.name)
    print(path, monster_name, monster_form)
```

## Installation
### Latest release
```bash
pip install cbpickaxe
```

### Development
```bash
git clone https://github.com/ExcaliburZero/cbpickaxe.git
cd cbpickaxe
pip install -e .
```

## Scripts
| Script        | Description |
| ------------- | ----------- |
| [generate_docs](https://cbpickaxe.readthedocs.io/en/latest/generate_docs/intro.html) | Generates HTML pages that document monsters, moves, items, etc. added by a mod. |
| [extract_translation](https://cbpickaxe.readthedocs.io/en/latest/other_scripts/extract_translation_strings.html) | Extracts the translations of given in-game text |
| [get_move_users](https://cbpickaxe.readthedocs.io/en/latest/other_scripts/get_move_users.html) | Finds all of the monster species that can use given moves. |
| [generate_monster_animations](https://cbpickaxe.readthedocs.io/en/latest/other_scripts/generate_monster_animations.html) | Creates animated gifs of monster battle animations. |

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "cbpickaxe",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "",
    "keywords": "Cassette Beasts",
    "author": "ExcaliburZero",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/03/c0/b8dbb7fb9983dfa14956f9c7a6b3b2fca777f1e04c96157a56fcfafd222b/cbpickaxe-0.1.2.tar.gz",
    "platform": null,
    "description": "# cbpickaxe [![Python library](https://github.com/ExcaliburZero/cbpickaxe/actions/workflows/python-library.yml/badge.svg)](https://github.com/ExcaliburZero/cbpickaxe/actions/workflows/python-library.yml) [![Documentation Status](https://readthedocs.org/projects/cbpickaxe/badge/?version=latest)](https://cbpickaxe.readthedocs.io/en/latest/?badge=latest)\nA Python library and set of scripts for data mining the game Cassette Beasts.\n\n```python\nimport cbpickaxe as cbp\n\nhoylake = cbp.Hoylake()\nhoylake.load_root(\"cassette_beasts\", \"Cassette Beasts\")\n\nfor monster_form in hoylake.load_monster_forms(\"res://data/monster_forms/\").values():\n    monster_name = hoylake.translate(monster_form.name)\n    print(path, monster_name, monster_form)\n```\n\n## Installation\n### Latest release\n```bash\npip install cbpickaxe\n```\n\n### Development\n```bash\ngit clone https://github.com/ExcaliburZero/cbpickaxe.git\ncd cbpickaxe\npip install -e .\n```\n\n## Scripts\n| Script        | Description |\n| ------------- | ----------- |\n| [generate_docs](https://cbpickaxe.readthedocs.io/en/latest/generate_docs/intro.html) | Generates HTML pages that document monsters, moves, items, etc. added by a mod. |\n| [extract_translation](https://cbpickaxe.readthedocs.io/en/latest/other_scripts/extract_translation_strings.html) | Extracts the translations of given in-game text |\n| [get_move_users](https://cbpickaxe.readthedocs.io/en/latest/other_scripts/get_move_users.html) | Finds all of the monster species that can use given moves. |\n| [generate_monster_animations](https://cbpickaxe.readthedocs.io/en/latest/other_scripts/generate_monster_animations.html) | Creates animated gifs of monster battle animations. |\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "A Python library and scripts for data mining the game Cassette Beasts.",
    "version": "0.1.2",
    "project_urls": {
        "Changelog": "https://github.com/ExcaliburZero/cbpickaxe/blob/master/CHANGELOG.md",
        "Documentation": "https://cbpickaxe.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/ExcaliburZero/cbpickaxe",
        "Issues": "https://github.com/ExcaliburZero/cbpickaxe/issues",
        "Repository": "https://github.com/ExcaliburZero/cbpickaxe.git"
    },
    "split_keywords": [
        "cassette",
        "beasts"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "52f570a9fc2e9cccadf2360440bf937a6e780fd7a3d9e152eb20658f8ad9760b",
                "md5": "73b88961594e2125a51a6cf79e008922",
                "sha256": "2c2ee733d7cba3e6e6174ba7c416980bbba21e36e09fa20cda184ddf3804f262"
            },
            "downloads": -1,
            "filename": "cbpickaxe-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "73b88961594e2125a51a6cf79e008922",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 37518,
            "upload_time": "2023-11-12T03:48:32",
            "upload_time_iso_8601": "2023-11-12T03:48:32.867975Z",
            "url": "https://files.pythonhosted.org/packages/52/f5/70a9fc2e9cccadf2360440bf937a6e780fd7a3d9e152eb20658f8ad9760b/cbpickaxe-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "03c0b8dbb7fb9983dfa14956f9c7a6b3b2fca777f1e04c96157a56fcfafd222b",
                "md5": "b67d0e1bca6cd35b1686123bd0420532",
                "sha256": "e53b6ec393c870715e0af7600af7a0d0095f74b672f93e64f88882bf10e71c2f"
            },
            "downloads": -1,
            "filename": "cbpickaxe-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "b67d0e1bca6cd35b1686123bd0420532",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 32466,
            "upload_time": "2023-11-12T03:48:34",
            "upload_time_iso_8601": "2023-11-12T03:48:34.405766Z",
            "url": "https://files.pythonhosted.org/packages/03/c0/b8dbb7fb9983dfa14956f9c7a6b3b2fca777f1e04c96157a56fcfafd222b/cbpickaxe-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-12 03:48:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ExcaliburZero",
    "github_project": "cbpickaxe",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cbpickaxe"
}
        
Elapsed time: 0.13236s