diff --git a/.codeclimate.yml b/.codeclimate.yml deleted file mode 100644 index b23e31309557ebe49a58d5247d8a8074e5826ece..0000000000000000000000000000000000000000 --- a/.codeclimate.yml +++ /dev/null @@ -1,20 +0,0 @@ -engines: - duplication: - enabled: true - config: - languages: - python: - - fixme: - enabled: true - markdownlint: - enabled: true - pep8: - enabled: true -exclude_paths: - - tests/** - - docs/** - - setup.py -ratings: - paths: - - minijson.pyx diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000000000000000000000000000000000000..350f37cbeeffa36fd602e1613a45b8f8bce9be73 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include minijson.pyx diff --git a/README.md b/README.md index 24f381a2429b3c918889fc586f2980538a1a1223..e808ca247eb94d12e84ef495d7f11c2fb7796189 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,34 @@ MiniJSON ======== -[](https://git.dms-serwis.com.pl/smokserwis/minijson) -[](https://git.dms-serwis.com.pl/smokserwis/minijson/-/commits/develop) -[](https://codeclimate.com/github/smok-serwis/minijson/maintainability) -[](https://codeclimate.com/github/smok-serwis/minijson) -[](https://pypi.python.org/pypi/minijson) -[](https://badge.fury.io/py/minijson) -[](https://pypi.python.org/pypi/minijson) -[]() -[](https://github.com/smok-serwis/minijson) - MiniJSON is a codec for a compact binary representation of a superset of JSON (binary values) are supported. +Documentation is available [here](https://smokserwis.docs.smok.co/minijson/), +along with the MiniJSON format specification. + Note ---- Active development of **minijson** is moved to this fork. -[Dronehub](https://github.com/Dronehub) has no interest in further developing this awesome -technology. +[Dronehub](https://github.com/Dronehub) has no interest in further +developing this awesome technology. -Usage ------ +Installation +------------ -Refer to the [documentation](http://minijson.readthedocs.io/en/latest/?badge=latest) -for use. +You should be able to install it from our own PyPI: +```bash +pip install --extra-index-url https://git.dms-serwis.com.pl/api/v4/projects/284/packages/pypi/simple minijson +``` + +There should be plenty of binaries available for multiple platforms. If you'd +like a new one, just file an issue If there are no binary wheels precompiled for this platform, you will need to compile it yourself. Alternatively, you can -[file an issue](https://github.com/smok-serwis/minijson/issues/new) +[file an issue](https://git.dms-serwis.com.pl/smokserwis/minijson/-/issues) and I'll do my best to compile a wheel for you. Compiling own wheels @@ -38,5 +36,3 @@ Compiling own wheels If there's no wheel, and you'd like to compile it on your own, you'll require [Cython](https://cython.org/) installed. - -Run the Dockerfile to launch unit tests locally.