|
| 1 | +================================================================================ |
| 2 | +pyexcel-pygal - Let you focus on data, instead of file formats |
| 3 | +================================================================================ |
| 4 | + |
| 5 | +.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png |
| 6 | + :target: https://www.patreon.com/pyexcel |
| 7 | + |
| 8 | +.. image:: https://api.travis-ci.org/pyexcel/pyexcel-pygal.svg?branch=master |
| 9 | + :target: http://travis-ci.org/pyexcel/pyexcel-pygal |
| 10 | + |
| 11 | +.. image:: https://codecov.io/github/pyexcel/pyexcel-pygal/coverage.png |
| 12 | + :target: https://codecov.io/github/pyexcel/pyexcel-pygal |
| 13 | + |
| 14 | +.. image:: https://readthedocs.org/projects/pyexcel-pygal/badge/?version=latest |
| 15 | + :target: http://pyexcel-pygal.readthedocs.org/en/latest/ |
| 16 | + |
| 17 | + |
| 18 | +**pyexcel-pygal** does xyz. |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | +Installation |
| 23 | +================================================================================ |
| 24 | +You can install it via pip: |
| 25 | + |
| 26 | +.. code-block:: bash |
| 27 | +
|
| 28 | + $ pip install pyexcel-pygal |
| 29 | +
|
| 30 | +
|
| 31 | +or clone it and install it: |
| 32 | + |
| 33 | +.. code-block:: bash |
| 34 | +
|
| 35 | + $ git clone https://github.com/pyexcel/pyexcel-pygal.git |
| 36 | + $ cd pyexcel-pygal |
| 37 | + $ python setup.py install |
| 38 | +
|
| 39 | +
|
| 40 | +
|
| 41 | +Development guide |
| 42 | +================================================================================ |
| 43 | + |
| 44 | +Development steps for code changes |
| 45 | + |
| 46 | +#. git clone https://github.com/pyexcel/pyexcel-pygal.git |
| 47 | +#. cd pyexcel-pygal |
| 48 | + |
| 49 | +Upgrade your setup tools and pip. They are needed for development and testing only: |
| 50 | + |
| 51 | +#. pip install --upgrade setuptools pip |
| 52 | + |
| 53 | +Then install relevant development requirements: |
| 54 | + |
| 55 | +#. pip install -r rnd_requirements.txt # if such a file exists |
| 56 | +#. pip install -r requirements.txt |
| 57 | +#. pip install -r tests/requirements.txt |
| 58 | + |
| 59 | + |
| 60 | +In order to update test environment, and documentation, additional steps are |
| 61 | +required: |
| 62 | + |
| 63 | +#. pip install moban |
| 64 | +#. git clone https://github.com/pyexcel/pyexcel-commons.git commons |
| 65 | +#. make your changes in `.moban.d` directory, then issue command `moban` |
| 66 | + |
| 67 | +What is rnd_requirements.txt |
| 68 | +------------------------------- |
| 69 | + |
| 70 | +Usually, it is created when a dependent library is not released. Once the dependecy is installed(will be released), the future version of the dependency in the requirements.txt will be valid. |
| 71 | + |
| 72 | +What is pyexcel-commons |
| 73 | +--------------------------------- |
| 74 | + |
| 75 | +Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project. |
| 76 | + |
| 77 | +What is .moban.d |
| 78 | +--------------------------------- |
| 79 | + |
| 80 | +`.moban.d` stores the specific meta data for the library. |
| 81 | + |
| 82 | +How to test your contribution |
| 83 | +------------------------------ |
| 84 | + |
| 85 | +Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases. |
| 86 | + |
| 87 | +On Linux/Unix systems, please launch your tests like this:: |
| 88 | + |
| 89 | + $ make |
| 90 | + |
| 91 | +On Windows systems, please issue this command:: |
| 92 | + |
| 93 | + > test.bat |
| 94 | + |
| 95 | + |
| 96 | +License |
| 97 | +================================================================================ |
| 98 | + |
| 99 | +New BSD License |
| 100 | + |
| 101 | +Support the project |
| 102 | +================================================================================ |
| 103 | + |
| 104 | +If your company has embedded pyexcel and its components into a revenue generating |
| 105 | +product, please `support me on patreon <https://www.patreon.com/bePatron?u=5537627>`_ to |
| 106 | +maintain the project and develop it further. |
0 commit comments