| Name | itg-cli JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-09-25 20:04:37 |
| 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
Command line interface that automates & simplifies common administrative tasks for Stepmania or its derivatives. 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 pip:
```Bash
pip install itg-cli
```
## Configuring
Running `itg-cli` with a command for the first time will generate a config file
at `~/.config/itg-cli.toml` and will populate it with a platform specific default
configuration (see below). If your itgmania installation location is not in the
default list below, 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` moves a specified song within your `packs` directory to the configured `censored` directory, removing them from play. (defaults to itg-cli/.censored if unset)
```Bash
itg-cli censor "path/to/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.
```
* `ping` prints "pong" and exits
```Bash
$ itg-cli ping
pong
```
## Contributing
This project is under active development, and my first published/marketed open source project, so I'm still learning how all this works in practice. That being said, I'll try to respond to any PRs or issues, though this may change in the future.
## 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/ae/4e/c63f4245e196f125dfac4de2d7d30d87372d0693dcd5bcdf168a89502292/itg_cli-0.0.3.tar.gz",
"platform": null,
"description": "# itg-cli\r\n\r\nCommand line interface that automates & simplifies common administrative tasks for Stepmania or its derivatives. Can also be imported as a package for use in a python project.\r\n\r\n## Setup\r\n\r\nMake sure you have python 3.9 or newer installed.\r\n\r\n```Bash\r\n$ python --version\r\nPython 3.9.20\r\n```\r\n\r\nInstall via pip:\r\n\r\n```Bash\r\npip install itg-cli\r\n```\r\n\r\n## Configuring\r\n\r\nRunning `itg-cli` with a command for the first time will generate a config file\r\nat `~/.config/itg-cli.toml` and will populate it with a platform specific default\r\nconfiguration (see below). If your itgmania installation location is not in the\r\ndefault list below, you will need to manually edit this config file in the text\r\neditor of your choice.\r\n\r\n```plaintext\r\nWindows: %appdata%\\ITGMania\r\nLinux: ~/.itgmania\r\nMacOS: ~/Library/Application Support/ITGMania\r\n MacOS cache: ~/Library/Caches/ITGMania\r\n```\r\n\r\n## Usage\r\n\r\n* `add-pack` adds a pack from the supplied path or link to your configured `packs` directory.\r\n \r\n ```Bash\r\n # Supports links to local .zip files\r\n itg-cli add-pack path/to/pack.zip\r\n # Or local directories:\r\n itg-cli add-pack path/to/pack/\r\n\r\n # Supports links to .zip files\r\n itg-cli add-pack https://omid.gg/THC\r\n # Google drive links sometimes contain special characters, so they should be surrounded in quotes\r\n itg-cli add-pack \"https://drive.google.com/file/d/18XoCKcA7N4ptE6U7wOJIJgfVwTAyuA10/view\"\r\n ```\r\n\r\n* `add-song` adds a song from the supplied path or link to your configured `singles` directory.\r\n\r\n ```Bash\r\n # Supports links to local .zip files\r\n itg-cli add-song path/to/song.zip\r\n # Or local directories:\r\n itg-cli add-song path/to/song/\r\n # Supports links to .zip files\r\n itg-cli add-song \"https://cdn.discordapp.com/attachments/529867916833718294/1286510412262805524/Love_Bomb.zip?ex=66ee2bb0&is=66ecda30&hm=6c6ac229657a01b0f48995ed236a22889502c5407478cfe6151596f4355ca7b4&\"\r\n ```\r\n\r\n* `censor` moves a specified song within your `packs` directory to the configured `censored` directory, removing them from play. (defaults to itg-cli/.censored if unset)\r\n\r\n ```Bash\r\n itg-cli censor \"path/to/7gays1pack/Stupid Hoe/\"\r\n ```\r\n\r\n* `uncensor` displays a list of songs that have been censored and prompts you to select a file to uncensor.\r\n\r\n ```Bash\r\n $ itg-cli uncensor\r\n 1. Monke Rave (Tech Heavy Charts)\r\n 2. Stupid Hoe (7gays1pack)\r\n 3. ME!ME!ME! (Anime Extravaganza 4)\r\n Select a song to uncensor (1-3): 1\r\n Uncensored Monke Rave from Tech Heavy Charts.\r\n ```\r\n\r\n* `ping` prints \"pong\" and exits\r\n\r\n ```Bash\r\n $ itg-cli ping\r\n pong\r\n ```\r\n\r\n## Contributing\r\n\r\nThis project is under active development, and my first published/marketed open source project, so I'm still learning how all this works in practice. That being said, I'll try to respond to any PRs or issues, though this may change in the future.\r\n\r\n## License\r\n\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\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": "0.0.3",
"project_urls": {
"Repository": "https://github.com/lucdar/itg-cli"
},
"split_keywords": [
"itg",
" cli",
" python",
" itgmania",
" stepmania"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7451a7a45a95cbb0d0e3b37c2251db19ffe4c0f5852016ffcec112d951546a94",
"md5": "8107f43395a86e4de0ce569e82ee1009",
"sha256": "1c1e3eb774ea4de8686ce4e33f242b9f345db6f57088fbeba71cb24bee2a9963"
},
"downloads": -1,
"filename": "itg_cli-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8107f43395a86e4de0ce569e82ee1009",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13918,
"upload_time": "2024-09-25T20:04:36",
"upload_time_iso_8601": "2024-09-25T20:04:36.195775Z",
"url": "https://files.pythonhosted.org/packages/74/51/a7a45a95cbb0d0e3b37c2251db19ffe4c0f5852016ffcec112d951546a94/itg_cli-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ae4ec63f4245e196f125dfac4de2d7d30d87372d0693dcd5bcdf168a89502292",
"md5": "4e4d92458826a7deb0ece966c0cf0d41",
"sha256": "bc49ad69350abdc793300c078d55be4a8b49fd37c4e097cb2fac4b2918b5407f"
},
"downloads": -1,
"filename": "itg_cli-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "4e4d92458826a7deb0ece966c0cf0d41",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 13754,
"upload_time": "2024-09-25T20:04:37",
"upload_time_iso_8601": "2024-09-25T20:04:37.137344Z",
"url": "https://files.pythonhosted.org/packages/ae/4e/c63f4245e196f125dfac4de2d7d30d87372d0693dcd5bcdf168a89502292/itg_cli-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-25 20:04:37",
"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"
}
