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 curvenoteRetrieve 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 --helpCommand Summary
get-melist my user information~$ python -m curvenote get-me API_TOKEN
get-my-projectslist all projects that the current user has access to~$ python -m curvenote get-my-projects API_TOKEN
pushupload 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-latexcreate 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/
Development
To use this library (in development):
Clone the repository
Activate your virtual environment
pip install -r requirements.txtRetrieve your API_TOKEN from curvenote support
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
File details
Details for the file curvenote-0.0.3.tar.gz.
File metadata
- Download URL: curvenote-0.0.3.tar.gz
- Upload date:
- Size: 19.4 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0c4928fceea394ebe6541a229f58ccdfc7810c2fd5c5c8883218e995c4763c81 |
|
| MD5 | 495140ffae59fdf224b483a5fd4dc8b9 |
|
| BLAKE2b-256 | db8b1440ee96208dc4d9fcb73a9fbcbf89cc593efd7dd5c9594d1f6db16dfe99 |
File details
Details for the file curvenote-0.0.3-py3-none-any.whl.
File metadata
- Download URL: curvenote-0.0.3-py3-none-any.whl
- Upload date:
- Size: 23.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 180c2bac52a9e0db33e88f689aa109d54fb38fa7710a36a5d9d49189ec614118 |
|
| MD5 | 522e653e6d3a46a819844fc49f333366 |
|
| BLAKE2b-256 | 6b6e10490544e11ca685b5b76e88edf4b81c5ba8160e0625c3614212d3e81223 |
