jutlib v0.1.0
==============
**Easy Python library for downloading anime episodes to user devices from service [jut.su](https://jut.su/anime/).**
Characteristics and functionality
----------------------------------
- Intuitive to use methods ;
- The ability to customize your configuration for the installer with the ability to change: title case, space separator, and resolution quality of the installing video ;
- Test files demonstrating how the library works in several directions in this folder ;
- Ease of integration of the library into your independent projects.
How to start using
-------------------
- First, make sure that your device has **_Python version 3.9_** or higher (using Python several versions lower may be possible, but I can’t tell you about stability) ;
- After that you can start installing the library in your virtual environment (global or local - it doesn’t matter) :
```shell
# for linux
python3 pip install jutsu-downloader
# for windows
pip install jutsu-downloader
```
- After installing the library in the environment, you can start using it for your own purposes ;
- Although the library does not provide such a wide range of functionality compared to collaborations, it does not contain any unnecessary mechanisms and is designed exclusively for its purpose.
Examples of using
------------------
What about documentation without [examples](https://github.com/BimbaXdeV/jutlib/tree/master/tests)? Let's go through the basic methods of this library :
- Initialization :
```python
# import main class from library
from jutsu.downloader import JutSu
# create an instance of the class "JutSu" based on the url you provided
jut = JutSu('YOUR URL TO DESIRED EPISODE')
# load data from the page you received and write it to the class parameters
jut.load()
```
- **Extracting** the video and **installing** it on the device :
```python
jut = JutSu('URL')
jut.load()
jut.download()
```
- For convenience or debugging, if desired, **you can display the received data loaded** into the instance :
```python
jut = JutSu('URL')
jut.load()
print(f'{jut.get_original_name()} : {jut.get_direct_link()}')
```
Features and customizations
----------------------------
**_Editing install configurations_**
- As I mentioned earlier - the library has slight customization **for integration into different projects**. Although the instance already has a configuration set for processes, **you can edit and replace the default values** ;
- To **change the configuration** of settings, the following method is built into the library :
```python
# before: "Anime Episode Name"
jut.configure(
download_res=720, # video quality category
name_separator='_', # parameter that will replace all spaces in the episode name
register_style='upper' # choose which register the names will be in
)
# after: "ANIME_EPISODE_NAME"
```
- But as you understand, customization settings also **have their own limits** that you cannot go beyond ;
- I advise you to familiarize yourself with **the list of acceptable settings** for the specified parameters :
```python
download_resolutions = (
1080,
720,
480,
360
)
name_separators = (
None # You can use absolutely any values as separators
)
register_styles = (
'default',
'upper',
'lower'
)
```
**_Editing static episode names_**
- Looking at the principle of operation of this library, one may ask: _"how, instead of the title of the episode loaded by the built-in method from the title on the page, can you give your name under which to install the video?"_ ;
- So, for such cases, there is also a method with which **you can set your name** for the episode in the class instance parameter after loading the page data :
```python
# use "jut.load()" before working with names
jut.set_name('YOUR NAME')
# done, video has heady to downloading
```
- If you need exactly the register in which you specified the new name, do not forget to set the **"default"** register style in the configuration :
```python
jut.configure(register_style='default')
```
- This will help you avoid problems with changing your name during the pre-installation processing.
Raw data
{
"_id": null,
"home_page": "https://github.com/BimbaXdeV/jutlib/",
"name": "jutlib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "jutsu, downloader, anime, jut",
"author": "BimbaXdeV",
"author_email": "kirillkirill497@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c2/2c/b92efbd4d0407cd3e20786eeb939bc091db9905eaf3c19261d9c8bf1a40f/jutlib-0.1.0.tar.gz",
"platform": null,
"description": "jutlib v0.1.0\n==============\n**Easy Python library for downloading anime episodes to user devices from service [jut.su](https://jut.su/anime/).**\n\nCharacteristics and functionality\n----------------------------------\n- Intuitive to use methods ;\n- The ability to customize your configuration for the installer with the ability to change: title case, space separator, and resolution quality of the installing video ;\n- Test files demonstrating how the library works in several directions in this folder ;\n- Ease of integration of the library into your independent projects.\n\nHow to start using\n-------------------\n- First, make sure that your device has **_Python version 3.9_** or higher (using Python several versions lower may be possible, but I can\u2019t tell you about stability) ;\n- After that you can start installing the library in your virtual environment (global or local - it doesn\u2019t matter) :\n\n```shell\n# for linux\npython3 pip install jutsu-downloader\n\n# for windows\npip install jutsu-downloader\n```\n\n- After installing the library in the environment, you can start using it for your own purposes ;\n- Although the library does not provide such a wide range of functionality compared to collaborations, it does not contain any unnecessary mechanisms and is designed exclusively for its purpose.\n\nExamples of using\n------------------\nWhat about documentation without [examples](https://github.com/BimbaXdeV/jutlib/tree/master/tests)? Let's go through the basic methods of this library :\n\n- Initialization :\n\n```python\n# import main class from library\nfrom jutsu.downloader import JutSu\n\n# create an instance of the class \"JutSu\" based on the url you provided\njut = JutSu('YOUR URL TO DESIRED EPISODE')\n\n# load data from the page you received and write it to the class parameters\njut.load()\n```\n\n- **Extracting** the video and **installing** it on the device :\n\n```python\njut = JutSu('URL')\njut.load()\njut.download()\n```\n\n- For convenience or debugging, if desired, **you can display the received data loaded** into the instance :\n\n```python\njut = JutSu('URL')\njut.load()\nprint(f'{jut.get_original_name()} : {jut.get_direct_link()}')\n```\n\nFeatures and customizations\n----------------------------\n**_Editing install configurations_**\n\n- As I mentioned earlier - the library has slight customization **for integration into different projects**. Although the instance already has a configuration set for processes, **you can edit and replace the default values** ;\n- To **change the configuration** of settings, the following method is built into the library :\n\n```python\n# before: \"Anime Episode Name\"\njut.configure(\n download_res=720, # video quality category\n name_separator='_', # parameter that will replace all spaces in the episode name\n register_style='upper' # choose which register the names will be in\n)\n# after: \"ANIME_EPISODE_NAME\"\n```\n\n- But as you understand, customization settings also **have their own limits** that you cannot go beyond ;\n- I advise you to familiarize yourself with **the list of acceptable settings** for the specified parameters :\n\n```python\ndownload_resolutions = (\n 1080,\n 720,\n 480,\n 360\n)\n\nname_separators = (\n None # You can use absolutely any values as separators\n)\n\nregister_styles = (\n 'default',\n 'upper',\n 'lower'\n)\n```\n\n**_Editing static episode names_**\n- Looking at the principle of operation of this library, one may ask: _\"how, instead of the title of the episode loaded by the built-in method from the title on the page, can you give your name under which to install the video?\"_ ;\n- So, for such cases, there is also a method with which **you can set your name** for the episode in the class instance parameter after loading the page data :\n\n```python\n# use \"jut.load()\" before working with names\njut.set_name('YOUR NAME')\n# done, video has heady to downloading\n```\n\n- If you need exactly the register in which you specified the new name, do not forget to set the **\"default\"** register style in the configuration :\n\n```python\njut.configure(register_style='default')\n```\n\n- This will help you avoid problems with changing your name during the pre-installation processing.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A small Python parser for installing anime episodes on user device from service jut.su",
"version": "0.1.0",
"project_urls": {
"Download": "https://github.com/BimbaXdeV/jutlib/archive/refs/heads/master.zip",
"Homepage": "https://github.com/BimbaXdeV/jutlib/"
},
"split_keywords": [
"jutsu",
" downloader",
" anime",
" jut"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f06844e597413e1a4c7b55372e81b88058782469f7dcd3bbe42d5eec2f426999",
"md5": "a239308909e1b9131f8f825ccdb8b852",
"sha256": "360f9e84bd66306b05f4df49324efbf1b3145d9aab9e53999fc170652570e70d"
},
"downloads": -1,
"filename": "jutlib-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a239308909e1b9131f8f825ccdb8b852",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6577,
"upload_time": "2024-10-16T07:09:15",
"upload_time_iso_8601": "2024-10-16T07:09:15.735358Z",
"url": "https://files.pythonhosted.org/packages/f0/68/44e597413e1a4c7b55372e81b88058782469f7dcd3bbe42d5eec2f426999/jutlib-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c22cb92efbd4d0407cd3e20786eeb939bc091db9905eaf3c19261d9c8bf1a40f",
"md5": "94b98057dc4d6e87df836dfff658f7bf",
"sha256": "ab130e8a7e1791f2c09251b151315045fb0458bdc0394e0a579e4e665295fcfd"
},
"downloads": -1,
"filename": "jutlib-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "94b98057dc4d6e87df836dfff658f7bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6161,
"upload_time": "2024-10-16T07:09:17",
"upload_time_iso_8601": "2024-10-16T07:09:17.551550Z",
"url": "https://files.pythonhosted.org/packages/c2/2c/b92efbd4d0407cd3e20786eeb939bc091db9905eaf3c19261d9c8bf1a40f/jutlib-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 07:09:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BimbaXdeV",
"github_project": "jutlib",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "jutlib"
}