Skip to main content

Helper library for curvenote versioning and tracking with Jupyter notebooks

Project description

The Curvenote Python client library and Command Line Interface. Access and interact with your projects via the Curvenote API.

Installation

~$ python -m pip install curvenote

Retrieve your API_TOKEN from curvenote support

CLI Usage

Access Curvenote projects via the command line. Get help on commands by:

~$ python -m curvenote --help
~$ python -m curvenote COMMAND --help

Command Summary

  • get-me list my user information
    ~$ python -m curvenote get-me API_TOKEN
  • get-my-projects list all projects that the current user has access to
    ~$ python -m curvenote get-my-projects API_TOKEN
  • push upload local documents into a curvenote project. .md (import and update existing) and .ipynb (import new only) files supported
    ~$ python -m curvenote push PATH PROJECT API_TOKEN
  • pull-as-latex create a local latex project and download contents of a Curvenote article into it
    ~$ python -m curvenote push TARGET PROJECT ARTICLE API_TOKEN --version=INTEGER

Python Client Usage

From Python - get curvenote blocks:

>>> import curvenote
>>> session = curvenote.Session(token=API_TOKEN)
>>> session.me()
>>> session.my_projects()
>>> session.get_block_latest(PROJECT_ID, BLOCK_ID)
>>> ...

From Python - push a local folder to a curvenote project:

>>> import curvenote
>>> session = curvenote.Session(token=AUTHORIZATION_TOKEN)
>>> proj = session.get_project("My Cool Project")
>>> session.push_folder("./cool_stuff/", proj)
>>> ...

There is also limited CLI functionality, though this still requires the Python installation:

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

curvenote-0.3.8.tar.gz (62.6 kB view details)

Uploaded Source

Built Distribution

curvenote-0.3.8-py3-none-any.whl (95.1 kB view details)

Uploaded Python 3

File details

Details for the file curvenote-0.3.8.tar.gz.

File metadata

  • Download URL: curvenote-0.3.8.tar.gz
  • Upload date:
  • Size: 62.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.6

File hashes

Hashes for curvenote-0.3.8.tar.gz
Algorithm Hash digest
SHA256 ad061ccad01e334019888e78f79618985e5449594bc8acd1278ac49c3ed6e50b
MD5 fb4066e186c7a51af446cb3c78564afb
BLAKE2b-256 bb16607c8dd1a3fd4df80efb6e045d8493023c53c4bfd737c9521183c7d1ff28

See more details on using hashes here.

File details

Details for the file curvenote-0.3.8-py3-none-any.whl.

File metadata

  • Download URL: curvenote-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 95.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.6

File hashes

Hashes for curvenote-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 df2e5564d7da6fe42be566675151d4d3256ce535cdcc2b7f3a1f01932bc12d6b
MD5 8d4e132b4e6c328f45f77a2b8284f084
BLAKE2b-256 3b93a46cd9afef1376dad325c4bea7eafdcc6eec0e3de8e774c9cdf45f7f0362

See more details on using hashes here.

Supported by

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