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.0.18.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

curvenote-0.0.18-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: curvenote-0.0.18.tar.gz
  • Upload date:
  • Size: 21.7 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.0.18.tar.gz
Algorithm Hash digest
SHA256 977fc2a6452c534554493832e39952173763260658fb2c1b7b56aa9e3e727990
MD5 058d88988e041dcdd44c303ee555b261
BLAKE2b-256 dc6b4bd910630b1aba64c2cda06aa2f336c563d758a3e4d5ccdd8b7f91aadca2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: curvenote-0.0.18-py3-none-any.whl
  • Upload date:
  • Size: 25.2 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.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 2f7b531fca8a858688cb59951d75c58ea24ed2ae98837868ce35d5ace37157c2
MD5 66e34edf1a197ce81bea55a9356a8885
BLAKE2b-256 22197942701129665509ba463c088285edddc9b6d8d4da1ac96114ee2530d966

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