Helper library for curvenote versioning and tracking with Jupyter notebooks
Project description
The curvenote Python client library for API access.
Installation
To use this library (in development):
Clone the repository
Activate your virtual environment
pip install -r requirements.txt
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:
Documentation
To build the documentation:
* Clone the repository
* Activate your virtual environment
* pip install -r requirements_dev.txt
* make docs
HTML doc pages will be written to ./build/html/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for curvenote-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71e8d3658e80a69fd75f72b6cd9bedfd788d3e160927425fbd6bf8b585b57fa7 |
|
MD5 | 65e9f937b85d8f518b5e33e344117310 |
|
BLAKE2b-256 | b09d8a32926363984c79597d0675f3f974f66da0c21d7fa023ac2c8936962255 |