# PKU - PKMN Utility Library
[][repo]
[][python]
[][pypi]
[][license]
<p align=center>
<img src="https://codeberg.org/wry/pku-lib/raw/branch/main/assets/icon.png" title="Pyukumuku" alt="Pyukumuku sprite">
</p>
## Installation
This library supports [CPython][python] 3.12 to 3.14.
1. Install the package from [PyPI] **(recommended)**
- The latest stable release.
- Potentially outdated.
```shell
python3 -m pip install pku-lib
```
2. Install the package from [Codeberg][repo]
- The most recent changes.
- Potentially unstable.
```shell
python3 -m pip install git+https://codeberg.org/wry/pku-lib.git
```
## Usage
To use the library, import `pku`.
```python
import pku
pku.hello()
```
## Development
1. **Install uv**
[uv](https://docs.astral.sh/uv/) is a tool for managing dependencies and
running tests. See the uv documentation for installation instructions.
2. **Set Up the Development Environment**
Once uv is installed, run the following command to ensure that all project
dependencies are installed and up-to-date.
```shell
uv sync
```
3. **Lint and Run Tests**
To ensure your code is consistent with the project and passes current tests,
run nox:
```shell
uv run nox
```
## License
This library is licensed under the [GNU Affero General Public License][license]
version 3.0 or later.
<!-- Hyperlinks! -->
[python]: https://python.org/downloads/ "Download Python"
[pypi]: https://pypi.org/project/pku-lib/ "Python Package Index"
[repo]: https://codeberg.org/wry/pku-lib/ "Codeberg repository"
[license]: https://www.gnu.org/licenses/agpl-3.0.en.html "GNU Affero General Public License"
Raw data
{
"_id": null,
"home_page": null,
"name": "pku-lib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "Taylor Rodr\u00edguez <git.rodriguez@proton.me>",
"keywords": "pk6, pk7, pk8, pk9, pkmn, pkx, pokemon, pok\u00e9mon, pyukumuku, rng, wry",
"author": null,
"author_email": "Taylor Rodr\u00edguez <git.rodriguez@proton.me>",
"download_url": "https://files.pythonhosted.org/packages/10/17/a7654bc639afb0ba19c70cba046a3490ea0eb136eba2441eb2e07c6623c1/pku_lib-0.1.2.tar.gz",
"platform": null,
"description": "# PKU - PKMN Utility Library\n\n[][repo]\n[][python]\n[][pypi]\n[][license]\n\n<p align=center>\n <img src=\"https://codeberg.org/wry/pku-lib/raw/branch/main/assets/icon.png\" title=\"Pyukumuku\" alt=\"Pyukumuku sprite\">\n</p>\n\n## Installation\n\nThis library supports [CPython][python] 3.12 to 3.14.\n\n1. Install the package from [PyPI] **(recommended)**\n\n- The latest stable release.\n- Potentially outdated.\n\n```shell\npython3 -m pip install pku-lib\n```\n\n2. Install the package from [Codeberg][repo]\n\n- The most recent changes.\n- Potentially unstable.\n\n```shell\npython3 -m pip install git+https://codeberg.org/wry/pku-lib.git\n```\n\n## Usage\n\nTo use the library, import `pku`.\n\n```python\nimport pku\n\npku.hello()\n```\n\n## Development\n\n1. **Install uv**\n\n[uv](https://docs.astral.sh/uv/) is a tool for managing dependencies and\nrunning tests. See the uv documentation for installation instructions.\n\n2. **Set Up the Development Environment**\n\nOnce uv is installed, run the following command to ensure that all project\ndependencies are installed and up-to-date.\n\n```shell\nuv sync\n```\n\n3. **Lint and Run Tests**\n\nTo ensure your code is consistent with the project and passes current tests,\nrun nox:\n\n```shell\nuv run nox\n```\n\n## License\n\nThis library is licensed under the [GNU Affero General Public License][license]\nversion 3.0 or later.\n\n<!-- Hyperlinks! -->\n\n[python]: https://python.org/downloads/ \"Download Python\"\n[pypi]: https://pypi.org/project/pku-lib/ \"Python Package Index\"\n[repo]: https://codeberg.org/wry/pku-lib/ \"Codeberg repository\"\n[license]: https://www.gnu.org/licenses/agpl-3.0.en.html \"GNU Affero General Public License\"\n",
"bugtrack_url": null,
"license": null,
"summary": "PKMN Utility Library",
"version": "0.1.2",
"project_urls": {
"changelog": "https://codeberg.org/wry/pku-lib/src/branch/main/CHANGELOG.md",
"repository": "https://codeberg.org/wry/pku-lib.git"
},
"split_keywords": [
"pk6",
" pk7",
" pk8",
" pk9",
" pkmn",
" pkx",
" pokemon",
" pok\u00e9mon",
" pyukumuku",
" rng",
" wry"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1017a7654bc639afb0ba19c70cba046a3490ea0eb136eba2441eb2e07c6623c1",
"md5": "cfaa014009335c5c37fb5c1cfcb02716",
"sha256": "e6334f802be920c528b2b3821a411be508723117c8807b5138883684520593fd"
},
"downloads": -1,
"filename": "pku_lib-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "cfaa014009335c5c37fb5c1cfcb02716",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 20563,
"upload_time": "2025-02-20T02:28:26",
"upload_time_iso_8601": "2025-02-20T02:28:26.279156Z",
"url": "https://files.pythonhosted.org/packages/10/17/a7654bc639afb0ba19c70cba046a3490ea0eb136eba2441eb2e07c6623c1/pku_lib-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-20 02:28:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "wry",
"codeberg_project": "pku-lib",
"lcname": "pku-lib"
}
JSON