Skip to content

Commit

Permalink
Update README and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
nizox committed Sep 21, 2020
1 parent 6e85055 commit 386e500
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 19 deletions.
27 changes: 11 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,14 +138,6 @@ We built Python wheels (prebuilt binaries) for macOS 64 bits, Linux 64 bits and
$ pip install py-mini-racer
If you're running Alpine, Pypi isn't able to host the dedicated wheels.
We're making them available with the following command.

.. code:: bash
$ pip install --index-url https://download.sqreen.io/python/alpine py-mini-racer
Build
-----

Expand All @@ -161,20 +153,17 @@ You can build the extension with the following command:

.. code:: bash
$ python setup.py build_ext
$ python helpers/v8_build.py
You can generate a wheel for whatever Python version with the command:

.. code:: bash
$ python setup.py build_ext # (for Python 2 and Python 3)
$ python setup.py bdist_wheel # (for Python 2 only)
$ python3 setup.py bdist_wheel # (for Python 3 only)
$ python3 helpers/build_package.py wheel dist
It will then build V8, the extension, and generates a wheel for your current
Python version. The V8 builds are cached in the ``py_mini_racer/extension/v8/``
directory. Please note that you can build Python 3 wheels by reusing the
cached version of V8 built with Python 2.7.
directory.

Notes for building on macOS
'''''''''''''''''''''''''''
Expand All @@ -187,11 +176,17 @@ They will allow to build a wheel compatible with former OSX versions.
Tests
-----

If you want to run the tests, you need to build the extension first, then launch:
If you want to run the tests, you need to build the extension first, first install pytest:

.. code-block:: bash
$ python -m pip install pytest
Then launch:

.. code:: bash
$ python setup.py test --addopts tests
$ python -m pytest tests
Credits
-------
Expand Down
2 changes: 1 addition & 1 deletion py_mini_racer/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
__author__ = 'Sqreen'
__email__ = 'hey@sqreen.io'
__version__ = '0.3.0'
__version__ = '0.4.0'

__all__ = ['py_mini_racer']
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
version=about["__version__"],
description="Minimal, modern embedded V8 for Python.",
long_description=readme + '\n\n' + history,
author='Sqreen',
author_email='hey@sqreen.io',
author=about["__author__"],
author_email=about["__email__"],
url='https://github.com/sqreen/PyMiniRacer',
packages=[
'py_mini_racer',
Expand Down

0 comments on commit 386e500

Please # to comment.