| Name | hypickle JSON |
| Version |
1.1.5
JSON |
| download |
| home_page | None |
| Summary | A script that outputs realtime stats for custom lists of friends you create. |
| upload_time | 2024-04-16 04:19:01 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
hypickle
hypixel
pit
bedwars
friends
stats
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# hypickle
A script that outputs realtime stats for custom lists of friends you create.
### Installation:
To install, run the following command:
`pip install hypickle`
Besides installing the script, this will also automatically install its dependencies (the libraries `requests`,
`rich`, `mplcursors`, `deepdiff`, and any of their own dependencies).
Then, create a new folder that will be used to store persistent information (such as friends lists you create).
In this folder, make a textfile called 'api-key.txt', and paste your hypixel api key as the first line.
- To get this api key, make a [hypixel developer account](https://developer.hypixel.net/).
The first part of [this](https://gist.github.com/camnwalter/c0156c68b1e2a21ec0b084c6f04b63f0#how-to-get-a-new-api-key-after-the-hypixel-api-changes)
guide is helpful to do this.
After setting this up, you will be able to open a terminal window in this directory and run various commands
with the `hypickle` script (explained below).
### Main features:
- Basic usage is to run with `hypickle *username/uuid*`
- This will output stats for the specified player, and then output any friends for them.
- Since the `friends` endpoint of hypixel's API was deprecated, you must manually add any friends for them you want.
To do this, run `hypickle addfriends *username/uuid*`
- If there's a player you run the program on often, consider making an alias for their uuid:
- Run `hypickle updateuuidaliases *username*`
- Then when running `hypickle *username*`, the program will automatically substitute the username for the uuid.
This is useful when running the program in quick succession for the same player, since the hypixel api forces a cooldown
when sending in a username instead of a uuid.
- You can also add an optional argument called 'all', if you'd like to output all friends (not just those currently online).
- E.g., `hypickle *username/uuid* all`
### Developer commands:
Open the root directory of the project in the terminal, and then:
- `python3 main.py *args*` allows you to test any local changes you've made to the project.
- `vulture .` will find unused code.
- `mypy .` will typecheck.
- `pylint *.py` will review the code for style.
- `pydeps hypickle` will output a dependency graph of the project's modules.
- `python my-linter.py` is a basic script I wrote that mainly attempts to find functions which are never/rarely used.
- `pytest tests.py` runs a few basic automated tests. To run manual tests (output to
the screen needs to be judged by the tester), run `python tests.py`.
- `vermin hypickle` deduces the oldest version of python that works to run the project. The expected output is 3.8, corresponding with `requires-python = ">= 3.8"` in `pyproject.toml`.
### Acknowledgements:
The `hypixel.py` and `leveling.py` files were originally from [Snuggle's repo](https://github.com/Snuggle/hypixel.py/). Since then I have made a number of modifications to them.
Raw data
{
"_id": null,
"home_page": null,
"name": "hypickle",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "hypickle, hypixel, pit, bedwars, friends, stats, api",
"author": null,
"author_email": "John Doknjas <jdoknjas@sfu.ca>",
"download_url": "https://files.pythonhosted.org/packages/71/81/80e4da3e095cfdcfb6f2463d53a3953231666cdbce2f7afc998e353de27d/hypickle-1.1.5.tar.gz",
"platform": null,
"description": "# hypickle\n\nA script that outputs realtime stats for custom lists of friends you create.\n\n### Installation:\n\nTo install, run the following command:\n\n`pip install hypickle`\n\nBesides installing the script, this will also automatically install its dependencies (the libraries `requests`,\n`rich`, `mplcursors`, `deepdiff`, and any of their own dependencies).\n\nThen, create a new folder that will be used to store persistent information (such as friends lists you create).\nIn this folder, make a textfile called 'api-key.txt', and paste your hypixel api key as the first line.\n - To get this api key, make a [hypixel developer account](https://developer.hypixel.net/).\n The first part of [this](https://gist.github.com/camnwalter/c0156c68b1e2a21ec0b084c6f04b63f0#how-to-get-a-new-api-key-after-the-hypixel-api-changes)\n guide is helpful to do this.\n\nAfter setting this up, you will be able to open a terminal window in this directory and run various commands\nwith the `hypickle` script (explained below).\n\n### Main features:\n\n- Basic usage is to run with `hypickle *username/uuid*`\n - This will output stats for the specified player, and then output any friends for them.\n - Since the `friends` endpoint of hypixel's API was deprecated, you must manually add any friends for them you want.\n To do this, run `hypickle addfriends *username/uuid*`\n- If there's a player you run the program on often, consider making an alias for their uuid:\n - Run `hypickle updateuuidaliases *username*`\n - Then when running `hypickle *username*`, the program will automatically substitute the username for the uuid.\n This is useful when running the program in quick succession for the same player, since the hypixel api forces a cooldown\n when sending in a username instead of a uuid.\n- You can also add an optional argument called 'all', if you'd like to output all friends (not just those currently online).\n - E.g., `hypickle *username/uuid* all`\n\n### Developer commands:\n\nOpen the root directory of the project in the terminal, and then:\n - `python3 main.py *args*` allows you to test any local changes you've made to the project.\n - `vulture .` will find unused code.\n - `mypy .` will typecheck.\n - `pylint *.py` will review the code for style.\n - `pydeps hypickle` will output a dependency graph of the project's modules.\n - `python my-linter.py` is a basic script I wrote that mainly attempts to find functions which are never/rarely used.\n - `pytest tests.py` runs a few basic automated tests. To run manual tests (output to\n the screen needs to be judged by the tester), run `python tests.py`.\n - `vermin hypickle` deduces the oldest version of python that works to run the project. The expected output is 3.8, corresponding with `requires-python = \">= 3.8\"` in `pyproject.toml`.\n\n### Acknowledgements:\n\nThe `hypixel.py` and `leveling.py` files were originally from [Snuggle's repo](https://github.com/Snuggle/hypixel.py/). Since then I have made a number of modifications to them.\n",
"bugtrack_url": null,
"license": null,
"summary": "A script that outputs realtime stats for custom lists of friends you create.",
"version": "1.1.5",
"project_urls": {
"Homepage": "https://github.com/johndoknjas/hypixel-online-friends"
},
"split_keywords": [
"hypickle",
" hypixel",
" pit",
" bedwars",
" friends",
" stats",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2df3035256c97e941a963937357e622a54a01d3ebad4b3622c0968b895d4f15",
"md5": "747d418db75c01ac0686b297b26a77f4",
"sha256": "c2239333103f0924ddd163b48128c263852cacdc662130c263aeabcee0c25d7e"
},
"downloads": -1,
"filename": "hypickle-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "747d418db75c01ac0686b297b26a77f4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 39579,
"upload_time": "2024-04-16T04:18:59",
"upload_time_iso_8601": "2024-04-16T04:18:59.900594Z",
"url": "https://files.pythonhosted.org/packages/f2/df/3035256c97e941a963937357e622a54a01d3ebad4b3622c0968b895d4f15/hypickle-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "718180e4da3e095cfdcfb6f2463d53a3953231666cdbce2f7afc998e353de27d",
"md5": "b6554930306dd94e8822e0697bf14446",
"sha256": "b5b21248c72c9695c592c0a6c6b4a266fe849e2e8a5fd443ef068f228932b321"
},
"downloads": -1,
"filename": "hypickle-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "b6554930306dd94e8822e0697bf14446",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 35074,
"upload_time": "2024-04-16T04:19:01",
"upload_time_iso_8601": "2024-04-16T04:19:01.951587Z",
"url": "https://files.pythonhosted.org/packages/71/81/80e4da3e095cfdcfb6f2463d53a3953231666cdbce2f7afc998e353de27d/hypickle-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 04:19:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "johndoknjas",
"github_project": "hypixel-online-friends",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hypickle"
}
