diff --git a/.travis.yml b/.travis.yml index fc81d2bf..1948ce24 100644 --- a/.travis.yml +++ b/.travis.yml @@ -55,6 +55,7 @@ language: python # Python version python: + - "3.4" - "3.5" - "3.6" diff --git a/CHANGES.rst b/CHANGES.rst index 9b96a812..b41d1169 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,4 +1,13 @@ Changes ======= -Still in alpha, no release yet. +0.0.2 (2017-07-28) +------------------ + +* Added and confirmed CPython 3.4 compatibility +* Added installation instructions to documentation + +0.0.1 (2017-07-28) +------------------ + +* First official (pre-) release of *zugbruecke* diff --git a/README.rst b/README.rst index f61c6308..ab31afd1 100644 --- a/README.rst +++ b/README.rst @@ -1,25 +1,43 @@ -.. |build_master| image:: https://travis-ci.org/pleiszenburg/zugbruecke.svg?branch=master - :target: https://travis-ci.org/pleiszenburg/zugbruecke +.. |build_master| image:: https://img.shields.io/travis/pleiszenburg/zugbruecke/master.svg?style=flat-square + :target: https://travis-ci.org/pleiszenburg/zugbruecke + :alt: Build Status: master / release -.. |build_develop| image:: https://travis-ci.org/pleiszenburg/zugbruecke.svg?branch=develop - :target: https://travis-ci.org/pleiszenburg/zugbruecke - -.. |docs_master| image:: https://readthedocs.org/projects/zugbruecke/badge/?version=latest +.. |docs_master| image:: https://readthedocs.org/projects/zugbruecke/badge/?version=latest&style=flat-square :target: http://zugbruecke.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status (master) + :alt: Documentation Status: master / release + +.. |build_develop| image:: https://img.shields.io/travis/pleiszenburg/zugbruecke/develop.svg?style=flat-square + :target: https://travis-ci.org/pleiszenburg/zugbruecke + :alt: Build Status: development branch -.. |docs_develop| image:: https://readthedocs.org/projects/zugbruecke/badge/?version=develop +.. |docs_develop| image:: https://readthedocs.org/projects/zugbruecke/badge/?version=develop&style=flat-square :target: http://zugbruecke.readthedocs.io/en/develop/?badge=develop - :alt: Documentation Status (master) + :alt: Documentation Status: development branch + +.. |license| image:: https://img.shields.io/pypi/l/zugbruecke.svg?style=flat-square + :target: https://github.com/pleiszenburg/zugbruecke/blob/master/LICENSE + :alt: Project License: LGPLv2 + +.. |status| image:: https://img.shields.io/pypi/status/zugbruecke.svg?style=flat-square + :target: https://github.com/pleiszenburg/zugbruecke/milestone/1 + :alt: Project Development Status -+--------------------+-------------------+-------------------+ -| master / release + |build_master| + |docs_master| + -+--------------------+-------------------+-------------------+ -| development branch + |build_develop| + |docs_develop| + -+--------------------+-------------------+-------------------+ +.. |pypi_version| image:: https://img.shields.io/pypi/v/zugbruecke.svg?style=flat-square + :target: https://pypi.python.org/pypi/zugbruecke + :alt: Available on PyPi - the Python Package Index -.. image:: http://www.pleiszenburg.de/zugbruecke_logo.png +.. |pypi_versions| image:: https://img.shields.io/pypi/pyversions/zugbruecke.svg?style=flat-square + :target: https://pypi.python.org/pypi/zugbruecke + :alt: Available on PyPi - the Python Package Index + +.. |zugbruecke_logo| image:: http://www.pleiszenburg.de/zugbruecke_logo.png + :target: https://github.com/pleiszenburg/zugbruecke + :alt: zugbruecke repository + +|build_master| |docs_master| |build_develop| |docs_develop| |license| |status| |pypi_version| |pypi_versions| + +|zugbruecke_logo| Synopsis ======== @@ -54,7 +72,7 @@ Prerequisites ============= +--------------------+--------------------------------------------------------------------------------------------------------+ -| for usage + - `CPython`_ 3.x (tested with 3.{5,6}) - no additional Python packages required + +| for usage + - `CPython`_ 3.x (tested with 3.{4,5,6}) - no additional Python packages required + | + - `Wine`_ 2.x (tested with 2.{5,6,10,12} regular & `staging`_) - expected to be in the user's `PATH`_ + +--------------------+--------------------------------------------------------------------------------------------------------+ | for tests + - `pytest`_ + @@ -74,15 +92,15 @@ Prerequisites Installation ============ -+--------------------+------------------------------------------------------------------------+ -| master / release + .. code:: bash + -| + + -| + pip install zugbruecke + -+--------------------+------------------------------------------------------------------------+ -| development branch + .. code:: bash + -| + + -| + pip install git+git://github.com/pleiszenburg/zugbruecke.git@develop + -+--------------------+------------------------------------------------------------------------+ ++--------------------+--------------------------------------------------------------------------+ +| master / release + .. code:: bash + +| + + +| |build_master| + pip install zugbruecke + ++--------------------+--------------------------------------------------------------------------+ +| development branch + .. code:: bash + +| + + +| |build_develop| + pip install git+https://github.com/pleiszenburg/zugbruecke.git@develop + ++--------------------+--------------------------------------------------------------------------+ Examples ======== @@ -92,7 +110,6 @@ Start an interactive Python session under Unix and try the following: .. code:: python from zugbruecke import cdll, c_double - dll_pow = cdll.msvcrt.pow dll_pow.argtypes = (c_double, c_double) dll_pow.restype = c_double diff --git a/docs/examples.rst b/docs/examples.rst index ef6a6401..26e30bbf 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -12,7 +12,7 @@ Examples ======== -A lot of code, which was written with ``cdll``, ``windll`` or ``oledll`` +A lot of code, which was written with ``ctypes``' ``cdll``, ``windll`` or ``oledll`` in mind and which runs under *Windows*, should run just fine with *zugbruecke* on Unix. diff --git a/docs/index.rst b/docs/index.rst index 9e661278..f2487178 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,7 @@ with *ctypes* from *Python* scripts. :maxdepth: 2 introduction + installation examples session memsync diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 00000000..99c065de --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,50 @@ +:github_url: + +.. _installation: + +.. index:: + pair: pip; install + triple: wine; linux; installation + triple: wine; macos; installation + triple: wine; bsd; installation + +Installation +============ + +Getting *Wine* +-------------- + +For using *zugbruecke*, you need to install **Wine** first. Depending on your platform, +there are different ways of doing that. + +* `Installation instructions for various Linux distributions`_ +* `Installation instructions for Mac OS X`_ +* `Installation instructions for FreeBSD`_ + +.. _Installation instructions for various Linux distributions: https://www.winehq.org/download +.. _Installation instructions for Mac OS X: https://wiki.winehq.org/MacOS +.. _Installation instructions for FreeBSD: https://wiki.winehq.org/FreeBSD + +Getting *zugbruecke* +-------------------- + +The latest (more or less) **stable release version** can be installed with *pip*: + +.. code:: bash + + pip install zugbruecke + +If you are interested in testing the latest work from the **development branch**, you can try it like this: + +.. code:: bash + + pip install git+https://github.com/pleiszenburg/zugbruecke.git@develop + +Installing *zugbruecke* in development mode +------------------------------------------- + +If you are interested in contributing to *zugbruecke*, you might want to install it in +development mode. You can find the latest instructions on how to do this in the +`CONTRIBUTING file`_ of this project on *Github*. + +.. _`CONTRIBUTING file`: https://github.com/pleiszenburg/zugbruecke/blob/master/CONTRIBUTING.rst diff --git a/setup.py b/setup.py index 06e85458..2b55b1c7 100644 --- a/setup.py +++ b/setup.py @@ -46,13 +46,13 @@ # Bump version HERE! -_version_ = '0.0.1' +_version_ = '0.0.2' # List all versions of Python which are supported confirmed_python_versions = [ ('Programming Language :: Python :: %s' % x) - for x in '3.5 3.6'.split() + for x in '3.4 3.5 3.6'.split() ]