<div align="center">Note Client</div>
---
## Usage
Note Client can automate the posting of articles on note. The content of the articles is written using Markdown notation.
We are currently releasing a beta version. In the beta version, you can use major headings, minor headings, bullet points, paragraph numbers, and horizontal lines. With future updates, customization such as bold text and quotations as well as the insertion of tables of contents will be available.
Note Client's source code is made available under the [MIT license](https://github.com/Mr-SuperInsane/NoteClient/blob/main/LICENSE).
[PyPI page](https://pypi.org/project/NoteClient) for this project.
## Documentation
[Japanese](https://note.com/naokun_gadget/n/naf129cb5f34b)
## Requirements
- Python >= 3.7
## Installation
```
pip install NoteClient
```
## Quick Example
```
from note_client import Note
EMAIL = 'your email'
PASSWORD = 'your password'
USER_ID = 'your user_id'
TITLE = 'Sample'
CONTENT_PATH = 'content.txt'
TAG_LIST = ['sample_tag']
# > If an image is specified, the index number is entered; if not, no description is given.
# INDEX = 0
# > True if the article is to be published, False if the article is to be saved as a draft; if not specified, the article is saved as a draft.
# POST_SETTING = True
# > True if the execution screen is not displayed, False if it is displayed, or not displayed if not specified.
# HEADLESS = False
# To specify the above three options, add them to the function arguments.
note = Note(email=EMAIL, password=PASSWORD, user_id=USER_ID)
print(note.create_article(title=TITLE, file_name=CONTENT_PATH, input_tag_list=TAG_LIST, image_index=None))
## If successful(Public).
# {'run':'success','title':'Sample','file_path':'content.txt','tag_list':['sample_tag'],'post_setting':'Public','post_url':'https://note.com/USER_ID/n/abc123'}
## If successful(Draft).
# {'run':'success','title':'Sample','file_path':'content.txt','tag_list':['sample_tag'],'post_setting':'Draft'}
## If unsuccessful.
# 'Required data is missing.'
```
### Sample
## Help
If you would like to make an enquiry about NoteClient, click [here](https://gist.github.com/Mr-SuperInsane/e9711c7f8b2722b0a03c9922e3f2ecdc).
Raw data
{
"_id": null,
"home_page": "https://github.com/Mr-SuperInsane/NoteClient",
"name": "NoteClient",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Nao Matsukami",
"author_email": "info@mr-insane.net",
"download_url": "https://files.pythonhosted.org/packages/36/f0/ac1b9c5e099378bc973eab886197d9654deace59d4bdd4a1736f39f09632/noteclient-0.1.6.tar.gz",
"platform": null,
"description": "\r\n<div align=\"center\">Note Client</div>\r\n\r\n---\r\n\r\n## Usage\r\n\r\nNote Client can automate the posting of articles on note. The content of the articles is written using Markdown notation. \r\n\r\nWe are currently releasing a beta version. In the beta version, you can use major headings, minor headings, bullet points, paragraph numbers, and horizontal lines. With future updates, customization such as bold text and quotations as well as the insertion of tables of contents will be available.\r\n\r\nNote Client's source code is made available under the [MIT license](https://github.com/Mr-SuperInsane/NoteClient/blob/main/LICENSE). \r\n\r\n[PyPI page](https://pypi.org/project/NoteClient) for this project.\r\n\r\n## Documentation\r\n\r\n[Japanese](https://note.com/naokun_gadget/n/naf129cb5f34b)\r\n\r\n## Requirements\r\n\r\n- Python >= 3.7\r\n\r\n## Installation\r\n\r\n```\r\npip install NoteClient\r\n```\r\n\r\n## Quick Example\r\n\r\n```\r\nfrom note_client import Note\r\n\r\nEMAIL = 'your email'\r\nPASSWORD = 'your password'\r\nUSER_ID = 'your user_id'\r\n\r\nTITLE = 'Sample'\r\nCONTENT_PATH = 'content.txt'\r\nTAG_LIST = ['sample_tag']\r\n\r\n# > If an image is specified, the index number is entered; if not, no description is given.\r\n# INDEX = 0\r\n\r\n# > True if the article is to be published, False if the article is to be saved as a draft; if not specified, the article is saved as a draft.\r\n# POST_SETTING = True\r\n\r\n# > True if the execution screen is not displayed, False if it is displayed, or not displayed if not specified.\r\n# HEADLESS = False\r\n\r\n# To specify the above three options, add them to the function arguments.\r\n\r\nnote = Note(email=EMAIL, password=PASSWORD, user_id=USER_ID)\r\nprint(note.create_article(title=TITLE, file_name=CONTENT_PATH, input_tag_list=TAG_LIST, image_index=None))\r\n\r\n## If successful(Public).\r\n# {'run':'success','title':'Sample','file_path':'content.txt','tag_list':['sample_tag'],'post_setting':'Public','post_url':'https://note.com/USER_ID/n/abc123'}\r\n\r\n## If successful(Draft).\r\n# {'run':'success','title':'Sample','file_path':'content.txt','tag_list':['sample_tag'],'post_setting':'Draft'}\r\n\r\n## If unsuccessful.\r\n# 'Required data is missing.'\r\n```\r\n\r\n\r\n### Sample\r\n\r\n\r\n## Help\r\n\r\nIf you would like to make an enquiry about NoteClient, click [here](https://gist.github.com/Mr-SuperInsane/e9711c7f8b2722b0a03c9922e3f2ecdc).\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Automatically posts articles on note",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/Mr-SuperInsane/NoteClient"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ee237ce067c2590d6a6fe4dc72db6e295b9be0dea4f70b390994df5084b4d10b",
"md5": "0b67f49f873ce95d86eeea772dabcdd2",
"sha256": "5b0af92732fbb8a18b4b186e677b13341f88881842a609a057647a11c9b61e29"
},
"downloads": -1,
"filename": "NoteClient-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b67f49f873ce95d86eeea772dabcdd2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6207,
"upload_time": "2024-08-14T17:25:50",
"upload_time_iso_8601": "2024-08-14T17:25:50.584715Z",
"url": "https://files.pythonhosted.org/packages/ee/23/7ce067c2590d6a6fe4dc72db6e295b9be0dea4f70b390994df5084b4d10b/NoteClient-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "36f0ac1b9c5e099378bc973eab886197d9654deace59d4bdd4a1736f39f09632",
"md5": "9da6b48b6c2bb8f1c561c157e857265b",
"sha256": "df5c7577480e67ef71e71b90a1bb250ec876b9e91d1294f0df8cf3790ea10ebd"
},
"downloads": -1,
"filename": "noteclient-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "9da6b48b6c2bb8f1c561c157e857265b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5942,
"upload_time": "2024-08-14T17:25:51",
"upload_time_iso_8601": "2024-08-14T17:25:51.600078Z",
"url": "https://files.pythonhosted.org/packages/36/f0/ac1b9c5e099378bc973eab886197d9654deace59d4bdd4a1736f39f09632/noteclient-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 17:25:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Mr-SuperInsane",
"github_project": "NoteClient",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "noteclient"
}
JSON
