A python implementation of esa.io API


License
MIT
Install
pip install esapy==1.1.0

Documentation

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.

PyPI version Python Versions MIT License

Description in Japanese: https://esa-pages.io/p/sharing/14661/posts/184/d983bd2e71ad35528500.html

INSTALATION

  1. Install pandoc

    $sudo apt install pandoc

    This package call nbconvert internally.

  2. Install package

    $pip install esapy
  3. generate esa.io 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.

HOW TO USE

  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.

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

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

LICENSE

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