README.rst 1.3 KB
Newer Older
Nicolas Chauvat's avatar
Nicolas Chauvat committed
1 2 3 4
This package provides base library for the Relationship Query Language

INSTALL
-------
5 6 7

the standard way:

Nicolas Chauvat's avatar
Nicolas Chauvat committed
8
python setup.py install
9 10 11 12

building rql binary extension in place:

python setup.py build_ext --inplace
13

Laurent Peuch's avatar
Laurent Peuch committed
14 15 16 17 18
DOCUMENTATION
-------------

Documentation is available at https://rql.readthedocs.io

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
HOW TO RELEASE?
---------------

Bump version number in __pkginfo__.py, then update the debian changelog with::

	dch -v <version>-1 -D unstable

Commit with ``hg commit -m "[pkg] Version <version>"`` and tag with ``hg tag
<version> debian/<version>-1``.

Ensure you have a clean working directory before upload to pypi by running
``hg clean --all --dirs --files`` (warning: this will remove all untracked
files).

Generate the source distribution with ``python3 setup.py sdist``.

rql has a faster implementation using libgecode. To make this available to
users using pip and not having libgecode installed, we publish manylinux
wheels to pypi.
38 39

To build a manylinux package for rql we use quay.io/pypa/manylinux1_x86_64
40
docker image and a custom script `build_wheel.sh` so you just have to execute
41 42
it and it will pull docker image and execute script in this image ::

43
	docker pull quay.io/pypa/manylinux_2_24_x86_64
44 45 46
	./build_wheel.sh

Then upload source dist and wheels to pypi using twine::
47

48
	twine upload dist/*.tar.gz dist/*.whl