This is a Python3 library for building Native Format Scores.
> **Note**: Currently this library supports _building_ Native Format Scores for the Native Format Smart Player, however reading or deserializing scores from JSON is currently unsupported.
## Requirements
- Python3
- virtualenv
## Installing
```bash
pip install nf_grapher
```
## Getting Started
Setup a virtual environment with the following:
```bash
virtualenv -p python3 e
source ./e/bin/activate
```
You can use whatever environment name you'd like, `e` is used here because it's short.
## Structure
This python library is divided into 3 modules. `nf_grapher.score` contains all the Score level objects
defined by the Native Format Score schema. `nf_grapher.typed` contains useful "typed" nodes defined
by the [smart player contract](../smart-player-contract.json). Because Python is not
statically typed, these types are not yet enforced. `nf_grapher.encoder` contains a function `encode`
for serializing grapher objects into JSON.
## Tests
Run tests with the following command:
```bash
python -m unittest discover -v
```
## Example Usage
```python
from nf_grapher.score import *
from nf_grapher.typed import *
from nf_grapher.encoder import encode
# Build a source node for a Spotify track
# Start from 5.6 seconds into the track and play for 5.6 seconds
source = FileNode('spotify:track:4RDKrwyA9YouzL1LxvMaxH', offset=5.6e+9, duration=5.6e+9)
# Create a 5.6 second loop from the beginning of the track
loop = LoopNode(when=0, duration=5.6e+9)
# Create the full score
score = Score(Graph(
nodes=[source, loop],
edges=[source.connect(loop)]
))
print(encode(score))
```
You can see a list of all supported typed nodes by using the Python `help` feature in a REPL.
For instance,
```bash
python
>>> from nf_grapher import typed
>>> help(typed)
```
1 maintainer
Metadata
1 maintainer
Release files for nf-grapher 1.2.12
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 | |
|---|---|---|---|---|
| nf_grapher-1.2.12.tar.gz | 9.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nf_grapher-1.2.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.3 kB
Release files / nf_grapher-1.2.12.tar.gz
| Download URL | nf_grapher-1.2.12.tar.gz |
|---|---|
| Size | 9.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e655f5714803820902d7d2854dec2a17fb13d569d8543c3ae6dc9b967f1b0eae
|
|
BLAKE2b-256 checksum How to use checksums |
38d9ef590662cd4b2ca17910ef7ae6a732e88b1852c2d8b7817fb49193db625a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.4
|
Release files / nf_grapher-1.2.12-py3-none-any.whl
| Download URL | nf_grapher-1.2.12-py3-none-any.whl |
|---|---|
| Size | 14.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bbda1492a4c9c36e980ab4e9e0f5619573a39c67dc75c35096c513487310e939
|
|
BLAKE2b-256 checksum How to use checksums |
e4fd37c6fdc1ee98ccd3ef34b5678d14bfa41991c91ddde9c5665cc894534525
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.4
|
Security for nf-grapher 1.2.12
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.
