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

TODO: UPDATE!

  • 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.5.6.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

curvenote-0.5.6-py3-none-any.whl (53.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: curvenote-0.5.6.tar.gz
  • Upload date:
  • Size: 36.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.7.6

File hashes

Hashes for curvenote-0.5.6.tar.gz
Algorithm Hash digest
SHA256 14092ca97c0075be1b9be5c56fc30b4448bed1a6f833280bbfac72db2a1cf520
MD5 c8596eb311c13a94ecafa0d5a3eded58
BLAKE2b-256 8436ea54039954fb11a6c6fd2fcc28638dc5bcbef90bda742f3ff365baa9787b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: curvenote-0.5.6-py3-none-any.whl
  • Upload date:
  • Size: 53.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.7.6

File hashes

Hashes for curvenote-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 52f2ebcb2d5d5e1a263d081e262da26fdb9f74844470f6a5eeacc25f4d91db95
MD5 421f1df6a61f063be0cda2cd7a682fc3
BLAKE2b-256 85efeaaa511fc10fde4ce80ac483c3c82c989d1f784e89bfa2257f778c04203c

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