Skip to main content

Automatically posts articles on note

Project description

Note Client

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.

PyPI page for this project.

Documentation

Japanese

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

noteclient-0.2.1.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

NoteClient-0.2.1-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file noteclient-0.2.1.tar.gz.

File metadata

  • Download URL: noteclient-0.2.1.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.9

File hashes

Hashes for noteclient-0.2.1.tar.gz
Algorithm Hash digest
SHA256 47fc59a0b43d9a74fd9551e0f9038459eeff218c5ff6f33bc9b07cf370468146
MD5 afb298865571ac30bb919878a162e9fd
BLAKE2b-256 1fead287edba728b9a755a1d72420e7836794fead8b7445b4dc57890991e551e

See more details on using hashes here.

File details

Details for the file NoteClient-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: NoteClient-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.9

File hashes

Hashes for NoteClient-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e30c50367183ac838fc5dc2afb611d6c5b0f8a5b3dca88395be9af8654fe9e7e
MD5 85a624647401141063cc8e39ba53814c
BLAKE2b-256 84e8bcbcedba876fa49b8ed5183d09b27787ae923972d5627ed5f5c733f2f1d6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page