Skip to content

Commit

Permalink
Updates to documentation and meta data. Preperation for first pypi pa…
Browse files Browse the repository at this point in the history
…ckage upload
  • Loading branch information
Grokzen committed Aug 24, 2014
1 parent c0f4fd7 commit 294666a
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 35 deletions.
43 changes: 17 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This framework is a port of the java version of the framework kwalify that can b

The source code can be found at: http://sourceforge.net/projects/kwalify/files/kwalify-java/0.5.1/

The schema used in this library: http://www.kuwata-lab.com/kwalify/ruby/users-guide.01.html#schema
The schema this library is base and extended from: http://www.kuwata-lab.com/kwalify/ruby/users-guide.01.html#schema



Expand All @@ -18,35 +18,26 @@ The schema used in this library: http://www.kuwata-lab.com/kwalify/ruby/users-gu



# How to install
# Installation


## Install stable release

Note: It is recomended allways to use a virtual-enviroment when using pyKwalify

1. Download a tar.gz release from https://github.com/Grokzen/pykwalify/releases
2. Run ``pip install pykwalify-yy.mm.xx.tar.gz``
3. Run ``pykwalify --help``



## Build from source

1. Clone the repo
2. Run ``make sdist``
3. Install with ``pip install dist/pykwalify-yy.mm.xx.tar.gz``

Latest stable release from pypi

```
$ pip install pykwalify
```

## Install from source
or from source

1. Clone the repo
2. Run ``make install`` or ``python setup.py install``
```
$ python setup.py install
```



## pyKwalify python dependencies
## python dependencies

- docopt 0.6.1
- PyYaml 3.11
Expand All @@ -62,24 +53,24 @@ Note: It is recomended allways to use a virtual-enviroment when using pyKwalify



# How to run tests
# How to test

Install test requirements with

```
pip install -r dev-requirements.txt
$ pip install -r dev-requirements.txt
```

Run tests with with the current python version
Run tests with

```
py.test
$ py.test
```

or if you want to test against all python versions run
or if you want to test against all python versions and pep8

```
tox
$ tox
```


Expand Down
5 changes: 3 additions & 2 deletions ReleaseNotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
Release Notes
=============

v14.06.2
========
v14.08
======

- First version to be uploaded to pypi
- Keyword 'range' can now be applied to map & seq types.
- Added many more test files.
- Keyword 'length' was removed because 'range' can handle all cases now.
Expand Down
2 changes: 1 addition & 1 deletion pykwalify/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

__author__ = 'Grokzen <Grokzen@gmail.com>'
# __version__ = '.'.join(map(str, __version_info__))
__foobar__ = "14.06.1"
__foobar__ = "14.08"

# Set to True to have revision from Version Control System in version string
__devel__ = True
Expand Down
25 changes: 19 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,38 @@

setup(
name="pykwalify",
version="14.06.1",
version="14.08",
description='Python lib/cli for JSON/YAML schema validation',
long_description=readme + '\n\n' + history,
author="Grokzen",
author="Johan Andersson",
author_email="Grokzen@gmail.com",
maintainer='Johan Andersson',
maintainer_email='Grokzen@gmail.com',
license='MIT',
packages=['pykwalify'],
scripts=['scripts/pykwalify'],
url='http://github.com/grokzen/pykwalify',
install_requires=[
'docopt==0.6.1',
'PyYAML==3.11',
],
classifiers=(
'Development Status :: 1 - Alpha',
# 'Development Status :: 1 - Planning',
# 'Development Status :: 2 - Pre-Alpha',
# 'Development Status :: 3 - Alpha',
'Development Status :: 4 - Beta',
# 'Development Status :: 5 - Production/Stable',
# 'Development Status :: 6 - Mature',
# 'Development Status :: 7 - Inactive',
'Intended Audience :: Developers',
'Operating System :: OS Independent',
'License :: OSI Approved :: MIT License',
'Environment :: Console',
'Operating System :: POSIX',
'Operating System :: Microsoft :: Windows',
'Programming Language :: Python',
'Programming Language :: Python :: 3.1',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.2',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
)
)

0 comments on commit 294666a

Please sign in to comment.