https://travis-ci.org/jbn/pathsjson.svg?branch=master

https://ci.appveyor.com/api/projects/status/xre5b722qk6ckqaf?svg=true

https://coveralls.io/repos/github/jbn/pathsjson/badge.svg?branch=master

https://img.shields.io/pypi/v/pathsjson.svg

https://img.shields.io/badge/license-MIT-blue.svg

https://img.shields.io/pypi/pyversions/pathsjson.svg

What is this?

A JSON-based DSL for describing paths in your project.

Why is this?

My etl/data analysis projects are littered with code like,

import os

DATA_DIR = "data"
CLEAN_DIR = os.path.join(DATA_DIR, "clean")
RAW_DIR = os.path.join(DATA_DIR, "raw")
TARGET_HTML = os.path.join(RAW_DIR, "something.html")
OUTPUT_FILE = os.path.join(CLEAN_DIR, "something.csv")

with open(TARGET_HTML) as fp:
    csv = process(fp)

with open(OUTPUT_FILE) as fp:
    write_csv(fp)

It’s fine for one file, but when you have a whole ELT pipeline tucked into a Makefile, the duplication leads to fragility and violates DRY. It’s a REALLY common pattern in file-based processing. This package and format lets you do create a .paths.json file like,

{
    "__ENV": {"VERSION": "0.0.1"},
    "DATA_DIR": ["data", "$$VERSION"],
    "CLEAN_DIR": ["$DATA_DIR", "clean"],
    "RAW_DIR": ["$DATA_DIR", "raw"],
    "SOMETHING_HTML": ["$RAW_DIR", "something.html"],
    "SOMETHING_CSV": ["$RAW_DIR", "something.csv"]
}

Then, from your python scripts,

from pathsjson.automagic import PATHS

print("Processing:", PATHS['SOMETHING_HTML'])
with PATHS.resolve('SOMETHING_HTML').open() as fp:
    csv = process(fp)

with PATHS.resolve('SOMETHING_CSV').open("w") as fp:
    write_csv(fp)

Installation

pip install pathsjson

Validation

There is a .paths.json schema. It’s validated with JSON-Schema.

More details

Read the docs: here.

Metadata

Release files for pathsjson 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pathsjson 0.0.3
File	Size	Uploaded	Provenance
pathsjson-0.0.3.tar.gz	12.0 kB	Nov 13, 2017	Without provenance	Details

Release files / pathsjson-0.0.3.tar.gz

Download URL	pathsjson-0.0.3.tar.gz
Size	12.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`61370bbfdfe99e068cd5582338d6d13af021031144bebecbfcf612b9c638488a`
BLAKE2b-256 checksum How to use checksums	`808e5066f27ada75500358cc2a69924fb999b0312e4937d09e756e392bd180ef`
Upload date	Nov 13, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Security for pathsjson 0.0.3

Report project as malware

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.