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

Uploaded Source

Built Distribution

curvenote-0.3.2-py3-none-any.whl (92.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: curvenote-0.3.2.tar.gz
  • Upload date:
  • Size: 60.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.2.tar.gz
Algorithm Hash digest
SHA256 56bf2b82a759c2a37da1658991f2e0d9e2d21ad3e4996ca8f7378ec7cc90c76b
MD5 f39e8aab403d3a7245bf648fe2b36bfc
BLAKE2b-256 a9a2f87765909d6ec0ca1690a9b7d4af78e5de650e0df3622ec5830d19614821

See more details on using hashes here.

File details

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

File metadata

  • Download URL: curvenote-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 92.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a53abe641bfdc9045faac2ed364f8e77bdc28e520415ab39d2235d04ec3a8e61
MD5 2c179e4f3d09c848f9fed9c0e8df742e
BLAKE2b-256 74bc3cef6b2e3979c5806c3b6e5b1e090542a9909750966f1a0ca430bcdb1c73

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