<p align="center">
<h1 style='font-size:38px;' align="center">neosekai-api</h1>
</p>
An Unoffical Python API for [neosekaitranslations.com](https://www.neosekaitranslations.com/)
<h2>Installation</h2>
from a terminal, run :
```
pip install neosekai-api
```
in case of an error, go [here](https://github.com/john-erinjery/neosekai-api/wiki/Installation) in the Github Wiki.
<h2>Usage</h2>
- Go to the [Github wiki](https://github.com/john-erinjery/neosekai-api/wiki) for this project to read full usage tutorial.
- Below is a short and sweet version
```python
from neosekai_api import Novel, NovelChapter
novel = Novel('https://www.neosekaitranslations.com/novel/oresuki/')
chapter = NovelChapter('https://www.neosekaitranslations.com/novel/oresuki/volume-1/chapter-3-part-3/')
```
- `Novel` and `NovelChapter` are the two main objects in this API
- through these two objects, neosekai-api offers a list of functions that are specified in the [Github wiki](https://github.com/john-erinjery/neosekai-api/wiki).
<h2>neosekai-dl</h2>
neosekai-dl is a project that uses neosekai-api to download novels from [neosekaitranslations.com](https://www.neosekaitranslations.com/) as PDF. The project is also in it's starting stages, so please bear with me. It's not a far fetch to say I made this API for the sole purpose of making neosekai-dl
<h2>For Future Releases</h2>
If you are using this project and wish to see more features in it, do open an issue on [github.](https://github.com/john-erinjery/neosekai-api) As I mentioned, I built this API for making neosekai-dl. This project, as it is, is all that is required for me to make neosekai-dl. However, if you wish to see more features in this API, I would be glad to implement your needs.
<h2>On creating support for authentification</h2>
neosekai-api, at the moment, does NOT support the registraton of new users or the ability to log in to neosekaitranslations.com. <br/>
This is mostly because, In neosekaitranslations.com, the only thing a registered user can do is leave comments. Since I feel like commenting is better done on the website itself, I didn't implement this functionality in the program.
Raw data
{
"_id": null,
"home_page": "https://github.com/john-erinjery/neosekai-api/",
"name": "neosekai-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "John Erinjery",
"author_email": "jancyvinod415@gmail.com",
"download_url": "",
"platform": null,
"description": "<p align=\"center\">\r\n<h1 style='font-size:38px;' align=\"center\">neosekai-api</h1>\r\n</p>\r\n\r\nAn Unoffical Python API for [neosekaitranslations.com](https://www.neosekaitranslations.com/)\r\n\r\n<h2>Installation</h2>\r\n\r\nfrom a terminal, run : \r\n\r\n```\r\npip install neosekai-api\r\n```\r\nin case of an error, go [here](https://github.com/john-erinjery/neosekai-api/wiki/Installation) in the Github Wiki.\r\n\r\n<h2>Usage</h2>\r\n\r\n- Go to the [Github wiki](https://github.com/john-erinjery/neosekai-api/wiki) for this project to read full usage tutorial.\r\n- Below is a short and sweet version\r\n\r\n```python\r\nfrom neosekai_api import Novel, NovelChapter\r\n\r\nnovel = Novel('https://www.neosekaitranslations.com/novel/oresuki/')\r\n\r\nchapter = NovelChapter('https://www.neosekaitranslations.com/novel/oresuki/volume-1/chapter-3-part-3/')\r\n```\r\n\r\n- `Novel` and `NovelChapter` are the two main objects in this API\r\n- through these two objects, neosekai-api offers a list of functions that are specified in the [Github wiki](https://github.com/john-erinjery/neosekai-api/wiki).\r\n \r\n<h2>neosekai-dl</h2>\r\n\r\nneosekai-dl is a project that uses neosekai-api to download novels from [neosekaitranslations.com](https://www.neosekaitranslations.com/) as PDF. The project is also in it's starting stages, so please bear with me. It's not a far fetch to say I made this API for the sole purpose of making neosekai-dl\r\n\r\n<h2>For Future Releases</h2>\r\n\r\nIf you are using this project and wish to see more features in it, do open an issue on [github.](https://github.com/john-erinjery/neosekai-api) As I mentioned, I built this API for making neosekai-dl. This project, as it is, is all that is required for me to make neosekai-dl. However, if you wish to see more features in this API, I would be glad to implement your needs.\r\n\r\n<h2>On creating support for authentification</h2>\r\n\r\nneosekai-api, at the moment, does NOT support the registraton of new users or the ability to log in to neosekaitranslations.com. <br/>\r\nThis is mostly because, In neosekaitranslations.com, the only thing a registered user can do is leave comments. Since I feel like commenting is better done on the website itself, I didn't implement this functionality in the program.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An Unoffical Python API for neosekaitranslations.com",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/john-erinjery/neosekai-api/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "589fc91cc72b5bb65252e1e6ac1765cb94969d1641d113eedc407e78188838ce",
"md5": "5a84a9195f0a5eeb856a4bf840441c1c",
"sha256": "8d1d445a1bb7d6c035724ac9738c89005d8abbbd0afae44352c0ce77ccbe5eff"
},
"downloads": -1,
"filename": "neosekai_api-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a84a9195f0a5eeb856a4bf840441c1c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6877,
"upload_time": "2023-05-06T02:53:10",
"upload_time_iso_8601": "2023-05-06T02:53:10.908879Z",
"url": "https://files.pythonhosted.org/packages/58/9f/c91cc72b5bb65252e1e6ac1765cb94969d1641d113eedc407e78188838ce/neosekai_api-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-06 02:53:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "john-erinjery",
"github_project": "neosekai-api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "neosekai-api"
}
JSON
