From 3a96b9a8d54ba59e7ac29658974c88f15d39b6fc Mon Sep 17 00:00:00 2001 From: Matthias Endler Date: Tue, 20 Nov 2018 00:50:49 +0100 Subject: [PATCH] First published version :tada: --- Makefile | 4 ++++ README.md | 7 +++++++ 2 files changed, 11 insertions(+) diff --git a/Makefile b/Makefile index d119789..723046e 100644 --- a/Makefile +++ b/Makefile @@ -24,6 +24,10 @@ nightly: ## Set rust compiler to nightly version install: nightly dev-packages ## Install hyperjson module into current virtualenv pipenv run pyo3-pack develop +.PHONY: publish +publish: ## Publish crate on Pypi + pipenv run pyo3-pack publish + .PHONY: clean clean: ## Clean up build artifacts pipenv --rm || true diff --git a/README.md b/README.md index 3152199..faea203 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,18 @@ drop-in replacement for Python's built-in around Rust's [serde-json](https://github.com/serde-rs/json) built with [pyo3](https://github.com/PyO3/pyo3). Compatible with Python 3 and 2 (not officially supported). This is alpha software and there will be bugs, so maybe don't deploy to production *just* yet. :wink: +## Installation + +``` +pip install hyperjson +``` + ## Usage hyperjson is meant as a drop-in replacement for Python's [json module](https://docs.python.org/3/library/json.html): + ```python >>> import hyperjson >>> hyperjson.dumps([{"key": "value"}, 81, True])