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.
Description in Japanese: https://esa-pages.io/p/sharing/14661/posts/184/d983bd2e71ad35528500.html
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 config
from command line.
- You can set them as environment variables:
HOW TO USE
-
Prepare .ipynb file
-
Convert to markdown and upload images.
$ esa up target.ipynb
This package uploads images, and uploads markdown file as a new post or update the previously uploaded post.
-
access the new post and edit.
-
if process fails due to a network problem, you can check by
esa stats
.
DOCUMENT
commands
This package registers following command line tools.
-
esa up <input_filepath>
- upload your file
- supported format: ipynb, tex, and md
-
esa config
- list environs and config
-
esa stats
- show statistics of your team
- This command can be used for access test.
-
esa reset <target.ipynb> [--number <post_number>]
- remove upload history by esapy in notebook file
- new post_number can be assigned
-
esa ls <dirname>
- show notebook list in the directory
<dirname>
can be abbreveated. Default is the current working directory.
config file
The config file (~/.esapyrc
) should be written in yaml format.
An example is shown below.
token: your_token
team: your_team
INSTALLATION for DEVELOPMENT
- setup poetry on your environment
- clone this repository
- cd repo directory
poetry install
git checkout develop
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.