Snip
Python Package of quality of life and helper functions to interface with the Snip Lab Book. Allows to create and upload snippets with relative ease. Store and retrieve api tokens, and more.
Features
- Token management: Store and retrieve api tokens in a secure keyring or in a configuration files.
- Python API: Python API to create and upload snippets to your lab books.
- CLI: Command line interface to interact with the Snip API.
- API Wrappers: Wrappers for the Snip API to make requests and handle responses.
Quickstart
Snip is distributed on PyPI. To use the package:
- Install the package using pip:
pip install snip-python
- Use the
snipcommand line interface (CLI) to interact with your lab books. For example, you can use thesnip tokencommand to store and retrieve your API tokens.
snip token --help
- Create and upload snippets to your lab books programmatically using the Python API.
from snip.snippets import ImageSnip
snip = ImageSnip.from_path("path/to/image.png", book_id="[YOUR_BOOK_ID]")
# show a preview of the snippet
snip.preview()
If you need help figuring out where to find the book id, please have a look here.
# upload the snippet
snip.upload()
The upload will automatically search your tokens in the keyring or in the configuration file and use the correct token to upload the snippet.
For more information, visit documentation.
1 maintainer
Metadata
1 maintainer
Release files for snip-python 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| snip_python-0.4.0.tar.gz | 572.3 kB | Without provenance | Details for snip_python-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| snip_python-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for snip_python-0.4.0-py3-none-any.whl |
Total release size: 607.0 kB
Release files / snip_python-0.4.0.tar.gz
| Download URL | snip_python-0.4.0.tar.gz |
|---|---|
| Size | 572.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e58a1e322773539087014740014fa244d633e639ed6c5ae77f69606b02d35513
|
|
BLAKE2b-256 checksum How to use checksums |
9927c579e18107ad88f7502e5af9905bb9ce8400eb6e23c2b41bdd338abf806e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / snip_python-0.4.0-py3-none-any.whl
| Download URL | snip_python-0.4.0-py3-none-any.whl |
|---|---|
| Size | 34.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7140c5937d9001d5c5e2a16b8f407397aef3efe5855d53f9b4747c3bfb83e9e8
|
|
BLAKE2b-256 checksum How to use checksums |
e6592c04fcd86048a44d5e29b4c4e2741fe49be64b93e5fd48aa222cf9a798a4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for snip-python 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
