| Name | itg-cli JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-11-26 00:09:42 |
| maintainer | None |
| docs_url | None |
| author | Lucas Clark |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 Lucas Clark Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
itg
cli
python
itgmania
stepmania
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# itg-cli
`itg-cli` is a command line interface that automates & simplifies common
administrative tasks for Stepmania or its derivatives. Its functionality can
also be imported as a package for use in a Python project.
## Setup
Make sure you have python 3.9 or newer installed.
```Bash
$ python --version
Python 3.9.20
```
Install via pipx (recommended):
1. Install [pipx](https://pipx.pypa.io/stable/)
2. ```Bash
pipx install itg-cli
```
Install via pip (for use as a module):
```Bash
pip install itg-cli
```
```python
from itg_cli import *
from pathlib import Path
packs = Path("/path/to/packs")
courses = Path("/path/to/courses")
add_pack("https://omid.gg/THC", packs, courses)
```
## Configuring
`itg-cli` will generate a config file if one is not found at the default
location. This location and the default values vary depending on the platform
(see below). The location of the created config file will be output by the
program after it's created.
The `init-config` command is used to write a default config file to a location
of your choice (or the default location if none is supplied). You can supply
this config file to other commands by passing it using the `--config`
parameter.
If your itgmania data folder location is not listed below (e.g. you are using a
portable install), you will need to manually edit this config file in the text
editor of your choice.
```plaintext
Windows: %appdata%\ITGMania
Linux: ~/.itgmania
MacOS: ~/Library/Application Support/ITGMania
MacOS cache: ~/Library/Caches/ITGMania
```
## Usage
* `add-pack` adds a pack from the supplied path or link to your configured `packs` directory.
```Bash
# Supports links to local .zip files
itg-cli add-pack path/to/pack.zip
# Or local directories:
itg-cli add-pack path/to/pack/
# Supports links to .zip files
itg-cli add-pack https://omid.gg/THC
# Google drive links sometimes contain special characters, so they should be surrounded in quotes
itg-cli add-pack "https://drive.google.com/file/d/18XoCKcA7N4ptE6U7wOJIJgfVwTAyuA10/view"
```
* `add-song` adds a song from the supplied path or link to your configured `singles` directory.
```Bash
# Supports links to local .zip files
itg-cli add-song path/to/song.zip
# Or local directories:
itg-cli add-song path/to/song/
# Supports links to .zip files
itg-cli add-song "https://cdn.discordapp.com/attachments/529867916833718294/1286510412262805524/Love_Bomb.zip?ex=66ee2bb0&is=66ecda30&hm=6c6ac229657a01b0f48995ed236a22889502c5407478cfe6151596f4355ca7b4&"
```
* `censor` Move a song in your packs folder to packs/.censored/\[pack]/\[SongFolder], hiding it from players.
```Bash
itg-cli censor "path/to/Songs/7gays1pack/Stupid Hoe/"
```
* `uncensor` displays a list of songs that have been censored and prompts you to select a file to uncensor.
```Bash
$ itg-cli uncensor
1. Monke Rave (Tech Heavy Charts)
2. Stupid Hoe (7gays1pack)
3. ME!ME!ME! (Anime Extravaganza 4)
Select a song to uncensor (1-3): 1
Uncensored Monke Rave from Tech Heavy Charts.
```
## Contributing
This project is my first published/marketed open source project, so I'm still
learning how all this works in practice. That being said, If you run into any bugs
or have ideas for new features, please feel free to create an [issue](https://github.com/lucdar/itg-cli/issues) or [pull request](https://github.com/lucdar/itg-cli/pulls).
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": null,
"name": "itg-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "itg, cli, python, itgmania, stepmania",
"author": "Lucas Clark",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b1/91/526c2d9144fe7776688ea6720f21ace41e0f79f3f1aad910b91c01e9ef3d/itg_cli-1.0.2.tar.gz",
"platform": null,
"description": "# itg-cli\n\n`itg-cli` is a command line interface that automates & simplifies common\nadministrative tasks for Stepmania or its derivatives. Its functionality can\nalso be imported as a package for use in a Python project.\n\n## Setup\n\nMake sure you have python 3.9 or newer installed.\n\n```Bash\n$ python --version\nPython 3.9.20\n```\n\nInstall via pipx (recommended):\n\n1. Install [pipx](https://pipx.pypa.io/stable/)\n\n2. ```Bash\n pipx install itg-cli\n ```\n\nInstall via pip (for use as a module):\n\n```Bash\npip install itg-cli\n```\n\n```python\nfrom itg_cli import *\nfrom pathlib import Path\n\npacks = Path(\"/path/to/packs\")\ncourses = Path(\"/path/to/courses\")\n\nadd_pack(\"https://omid.gg/THC\", packs, courses)\n```\n\n## Configuring\n\n`itg-cli` will generate a config file if one is not found at the default\nlocation. This location and the default values vary depending on the platform\n(see below). The location of the created config file will be output by the\nprogram after it's created.\n\nThe `init-config` command is used to write a default config file to a location\nof your choice (or the default location if none is supplied). You can supply\nthis config file to other commands by passing it using the `--config`\nparameter.\n\nIf your itgmania data folder location is not listed below (e.g. you are using a\nportable install), you will need to manually edit this config file in the text\neditor of your choice.\n\n```plaintext\nWindows: %appdata%\\ITGMania\nLinux: ~/.itgmania\nMacOS: ~/Library/Application Support/ITGMania\n MacOS cache: ~/Library/Caches/ITGMania\n```\n\n## Usage\n\n* `add-pack` adds a pack from the supplied path or link to your configured `packs` directory.\n \n ```Bash\n # Supports links to local .zip files\n itg-cli add-pack path/to/pack.zip\n # Or local directories:\n itg-cli add-pack path/to/pack/\n\n # Supports links to .zip files\n itg-cli add-pack https://omid.gg/THC\n # Google drive links sometimes contain special characters, so they should be surrounded in quotes\n itg-cli add-pack \"https://drive.google.com/file/d/18XoCKcA7N4ptE6U7wOJIJgfVwTAyuA10/view\"\n ```\n\n* `add-song` adds a song from the supplied path or link to your configured `singles` directory.\n\n ```Bash\n # Supports links to local .zip files\n itg-cli add-song path/to/song.zip\n # Or local directories:\n itg-cli add-song path/to/song/\n # Supports links to .zip files\n itg-cli add-song \"https://cdn.discordapp.com/attachments/529867916833718294/1286510412262805524/Love_Bomb.zip?ex=66ee2bb0&is=66ecda30&hm=6c6ac229657a01b0f48995ed236a22889502c5407478cfe6151596f4355ca7b4&\"\n ```\n\n* `censor` Move a song in your packs folder to packs/.censored/\\[pack]/\\[SongFolder], hiding it from players.\n\n ```Bash\n itg-cli censor \"path/to/Songs/7gays1pack/Stupid Hoe/\"\n ```\n\n* `uncensor` displays a list of songs that have been censored and prompts you to select a file to uncensor.\n\n ```Bash\n $ itg-cli uncensor\n 1. Monke Rave (Tech Heavy Charts)\n 2. Stupid Hoe (7gays1pack)\n 3. ME!ME!ME! (Anime Extravaganza 4)\n Select a song to uncensor (1-3): 1\n Uncensored Monke Rave from Tech Heavy Charts.\n ```\n\n## Contributing\n\nThis project is my first published/marketed open source project, so I'm still\nlearning how all this works in practice. That being said, If you run into any bugs\nor have ideas for new features, please feel free to create an [issue](https://github.com/lucdar/itg-cli/issues) or [pull request](https://github.com/lucdar/itg-cli/pulls).\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Lucas Clark Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": null,
"version": "1.0.2",
"project_urls": {
"Repository": "https://github.com/lucdar/itg-cli"
},
"split_keywords": [
"itg",
" cli",
" python",
" itgmania",
" stepmania"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bf695f6622de9a5d87350d73052c789d9c2a1a75295d134a111ba0eb04b63ee9",
"md5": "0b0abf36806c888941f5809c63835510",
"sha256": "e8a288d02d764954ece5682d727471fa63e14dc42b6366cac9d147ae86d5d6ed"
},
"downloads": -1,
"filename": "itg_cli-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b0abf36806c888941f5809c63835510",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15057,
"upload_time": "2024-11-26T00:09:41",
"upload_time_iso_8601": "2024-11-26T00:09:41.924512Z",
"url": "https://files.pythonhosted.org/packages/bf/69/5f6622de9a5d87350d73052c789d9c2a1a75295d134a111ba0eb04b63ee9/itg_cli-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b191526c2d9144fe7776688ea6720f21ace41e0f79f3f1aad910b91c01e9ef3d",
"md5": "7a96b84b46e47733cec04a20331aca9f",
"sha256": "4d8b995b1fa00cf6d984e4e59db16c631d4a9341e51c53c4f39b159e2edc3ba6"
},
"downloads": -1,
"filename": "itg_cli-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "7a96b84b46e47733cec04a20331aca9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14985,
"upload_time": "2024-11-26T00:09:42",
"upload_time_iso_8601": "2024-11-26T00:09:42.906373Z",
"url": "https://files.pythonhosted.org/packages/b1/91/526c2d9144fe7776688ea6720f21ace41e0f79f3f1aad910b91c01e9ef3d/itg_cli-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 00:09:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lucdar",
"github_project": "itg-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "itg-cli"
}
