From 2dcd9a7ec386686c08f1b4c30fc06d6972de223e Mon Sep 17 00:00:00 2001 From: Zygmunt Krynicki Date: Thu, 23 Jun 2011 16:25:37 +0200 Subject: [PATCH] Update documentation --- HACKING | 1 - INSTALL | 1 - NEWS | 1 - README | 12 +++--------- doc/changes.rst | 7 ++++++- doc/hacking.rst | 24 +++++++++++++----------- doc/installation.rst | 42 +----------------------------------------- 7 files changed, 23 insertions(+), 65 deletions(-) delete mode 100644 HACKING delete mode 100644 INSTALL delete mode 100644 NEWS diff --git a/HACKING b/HACKING deleted file mode 100644 index a512792..0000000 --- a/HACKING +++ /dev/null @@ -1 +0,0 @@ -See doc/hacking.rst diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 0974de5..0000000 --- a/INSTALL +++ /dev/null @@ -1 +0,0 @@ -See doc/installation.rst diff --git a/NEWS b/NEWS deleted file mode 100644 index 0ece6dc..0000000 --- a/NEWS +++ /dev/null @@ -1 +0,0 @@ -See doc/changes.rst diff --git a/README b/README index eede647..f8b92b9 100644 --- a/README +++ b/README @@ -1,16 +1,10 @@ About ===== -This source package contains useful JSON utilities developed by the Linaro -(www.linaro.org) Infrastructure Team. +This package contains an implementation of JSON Schema validator as defined by +http://json-schema.org/ Installation ============ -See INSTALL - -Reporting Bugs -============== - -All bugs should be reported to the launchpad project at -https://bugs.launchpad.net/linaro-python-json/+filebug +pip install json-schema-validator diff --git a/doc/changes.rst b/doc/changes.rst index 3cdcdef..c809c9b 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -1,6 +1,11 @@ Version History *************** +Version 2.1 +=========== + +* Renamed from linaro-json to json-schema-validator and moved to github. + Version 2.0.1 ============= @@ -37,7 +42,7 @@ Version 1.2.1 Version 1.2 =========== -* Change name to linaro-json +* Change name to json-schema-validator * Add dependency on versiontools * Register on pypi * Add ReST documentation diff --git a/doc/hacking.rst b/doc/hacking.rst index 84bd299..9b9b2de 100644 --- a/doc/hacking.rst +++ b/doc/hacking.rst @@ -2,18 +2,15 @@ Hacking ******* -Dear hackers. - -The project is hosted on http://launchpad.net/linaro-python-json/ *and* -http://pypi.python.org/linaro-json/. There is a name difference, the canonical -name is ``linaro-json``. I cannot rename the project on launchpad so we'll have -to live with both. +The project is hosted on github +(http://github.com/zyga/json-schema-validator/), feel free to fork it and +propose a pull request. Goals ----- -The goal of this project is to construct an universal collection of tools to -work with JSON documents in python. +The goal of this project is to construct a complete and fast implementation of the +JSON Schema as defined by http://json-schema.org/. JSON is powerful because of the simplicity. Unlike the baroque YAML it thrives on being easy to implement in any language, correctly, completely, with @@ -26,11 +23,16 @@ and integrity checking. Infrastructure -------------- -Launchpad.net is used for: +Github is used for: -* Hosting source code (in bzr) +* Hosting source code (in git) * Reporting and tracking bugs -* Project management (release tracking, feature tracking, etc) + + +Launchpad.net is used for: + +* Hosting source code (as bzr mirror) +* Packaging aid for Ubuntu PyPi is used for: diff --git a/doc/installation.rst b/doc/installation.rst index e2e25be..2527099 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -23,27 +23,6 @@ Installation Options There are several installation options available: -Using Ubuntu PPAs ------------------ - -For Ubuntu 10.04 onward there is a PPA (personal package archive): - -* ppa:zkrynicki/lava - -This PPA has only stable releases. To add it to an Ubuntu system use the -add-apt-repository command:: - - sudo add-apt-repository ppa:zkrynicki/lava - -After you add the PPA you need to update your package cache:: - - sudo apt-get update - -Finally you can install the package, it is called `python-linaro-json`:: - - sudo apt-get install python-linaro-json - - Using Python Package Index -------------------------- @@ -51,23 +30,4 @@ This package is being actively maintained and published in the `Python Package Index `_. You can install it if you have `pip `_ tool using just one line:: - pip install linaro-json - - -Using source tarball --------------------- - -To install from source you must first obtain a source tarball from either -`pypi project page `_ -or from `Launchpad project page `_. -To install the package unpack the tarball and run:: - - python setup.py install - -You can pass ``--user`` if you prefer to do a local (non system-wide) installation. - -.. note:: - - To install from source you will need distutils (replacement of setuptools) - They are typically installed on any Linux system with python but on Windows - you may need to install that separately. + pip install json-schema-validator