brython-pack 0.0.3
packages your Python packages/files into a brython_modules.js
License: MIT
Keywords: python

================================================================================
brython-pack - Pack up your python package for Brython.js
================================================================================

.. image:: https://api.travis-ci.org/chfw/brython-pack.svg
   :target: http://travis-ci.org/chfw/brython-pack

.. image:: https://codecov.io/github/chfw/brython-pack/coverage.png
   :target: https://codecov.io/github/chfw/brython-pack



Introduction
================================================================================

**brython-pack** packages your Python packages/files into a brython_modules.js. The output is a `brython_modules.js`_ in your
current directory. It is used to pack up `pyecharts.js`_

.. _brython_modules.js: https://github.com/chfw/pyecharts.js/tree/master/public/js
.. _pyecharts.js: https://chfw.github.io/pyecharts.js


Installation
================================================================================


You can install brython-pack via pip:

.. code-block:: bash

    $ pip install brython-pack


or clone it and install it:

.. code-block:: bash

    $ git clone https://github.com/chfw/brython-pack.git
    $ cd brython-pack
    $ python setup.py install

Limitation
================================================================================

It **cannot** collect the package dependency on built-in python modules (the dependencies on brython_stdlib.js)
for you. You need to figure it out by yourself and save it in a requirements.txt file.
Once you will have the dependency list, the packing step is straight foward.

Usage
================================================================================

::

   usage:
   
       bp brython_stdlib.js requirements.txt your packages and file list
   
   where:
   
       brython_stdlib.js: should be the accessible path to the lib file.
       requirements.txt: is the hard coded and manually worked out dependencies
                         on brython_stdlib.txt. Not the pip requirements.txt.
       your packages file list: could be given as space separated arguments.
   
   examples:
   
       bp dependencies/brython_stdlib.js requirements.txt pyecharts editor.py

If you are wondering what the requirements.txt file look like, here is an example
`requirement.txt <https://github.com/chfw/pyecharts.js/blob/master/bp-requirements.txt>`_

Change log
================================================================================

0.0.3 - 13/07/2018
--------------------------------------------------------------------------------

Added
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. filtering out lengthy docstring that starts with 'r"""'
#. `#1 <https://github.com/chfw/brython-pack/pull/1>`_: cope with unicode in
   python files

0.0.2 - 23/10/2017
--------------------------------------------------------------------------------

Removed
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. pyexcel `#105 <https://github.com/pyexcel/pyexcel/issues/105>`_, remove gease
   from setup_requires, introduced by 0.1.3.

0.0.1 - 19/10/2017
--------------------------------------------------------------------------------

First commit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. being able to create an optimal brython_modules.js