Skip to main content

A python implementation of API

Project description


A python implementation of API

The main purpose of this package is implementation of easy uploading and sharing jupyter notebook to service.

PyPI version Python Versions MIT License

Description in Japanese:


  1. Install pandoc

    $sudo apt install pandoc

    This package call nbconvert internally.

  2. Install package

    $pip install esapy
  3. generate token with read/write permission.

  4. 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.


  1. Prepare .ipynb file

  2. 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.

  3. access the new post and edit.

  4. if process fails due to a network problem, you can check by esa stats.



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


  1. setup poetry on your environment
  2. clone this repository
  3. cd repo directory
  4. poetry install
  5. git checkout develop


Copyright (c) 2020 Kosuke Mizuno
This package is released under the MIT license (see LICENSE file).

Project details

Download files

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

Files for esapy, version 1.3.1
Filename, size File type Python version Upload date Hashes
Filename, size esapy-1.3.1-py3-none-any.whl (18.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size esapy-1.3.1.tar.gz (18.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page