From b4c5850575f8e6381e6e02646164dc38c416cac4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@ericsson.com> Date: Tue, 13 Aug 2024 16:18:06 +0200 Subject: [PATCH] fixes and removal of things --- .codeclimate.yml | 20 -------------------- MANIFEST.in | 1 + README.md | 34 +++++++++++++++------------------- 3 files changed, 16 insertions(+), 39 deletions(-) delete mode 100644 .codeclimate.yml create mode 100644 MANIFEST.in diff --git a/.codeclimate.yml b/.codeclimate.yml deleted file mode 100644 index b23e313..0000000 --- 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 0000000..350f37c --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include minijson.pyx diff --git a/README.md b/README.md index 24f381a..e808ca2 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. -- GitLab