A python implementation of esa.io API
Project description
esapy
A python implementation of esa.io API
The main purpose of this package is implementation of easy uploading and sharing jupyter notebook to esa.io service.
INSTALATION
-
Install pandoc
$ sudo apt install pandoc
This package call nbconvert internally.
-
Install package
$ pip install esapy
-
generate esa.io token with read/write permission.
-
make configuration file in your home directory (~/.esapyrc).
token: your_token team: your_team
- You can set them as environment variables: ESA_PYTHON_TOKEN, ESA_PYTHON_TEAM.
- Environment variables are prior to .esapyrc file.
- You can check your token using
esa-token
.
HOW TO USE
-
Prepare .ipynb file
-
Convert to markdown and upload images.
$ esa-up target.ipynb
This package (for now) will call nbconvert and upload images, and will not upload markdown file as new post.
-
Post a new article by copy-and-paste the generated markdown file.
DOCUMENT
commands
This package registers following cli commands.
- esa-up <target.ipynb>
- upload your notebook
- jupyter-esa-up <target.ipynb>
- an alias of
esa-up
- an alias of
- esa-token
- show your token and team name
config file
The config file (~/.esapyrc) should be written in yaml format. An example is shown below.
token: your_token
team: your_team
action:
goto_clipboard: true
If action.goto_clipboard
is true, a markdown body with modified urls will be copied to clipboard. Default is false.
License
Copyright (c) 2020 Kosuke Mizuno
This package is released under the MIT license (see LICENSE file).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.