Skip to content

Commit 27a9e13

Browse files
committed
Add reportlab as a dependency in setup.py.
1 parent cc3fe0a commit 27a9e13

File tree

7 files changed

+60
-32
lines changed

7 files changed

+60
-32
lines changed

docs/anaconda-installation.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. image:: ../artwork/toyplot.png
2+
:width: 200px
3+
:align: right
4+
5+
.. _anaconda-installation:
6+
7+
Anaconda Installation
8+
=====================
9+
10+
Whether you’re new to Python or an old hand, we highly recommend installing
11+
`Anaconda <https://www.continuum.io/downloads>`_. Anaconda includes and
12+
conveniently installs Python and other commonly used packages for scientific
13+
computing and data science, including most of Toyplot's dependencies.
14+
15+
With Anaconda installed, do the following to install Toyplot::
16+
17+
$ conda install pip numpy multipledispatch reportlab
18+
$ pip install toyplot
19+
20+
Note that there is a Conda package for Toyplot, but (as of this writing) it's fairly
21+
out of date ... see the package information at
22+
23+
https://binstar.org/melund/toyplot
24+
25+
and (in the nicest way possible) let the Anaconda maintainers know you're using Toyplot!

docs/conda-installation.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/dependencies.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Dependencies
1010
Required
1111
--------
1212

13-
To use Toyplot you'll need the following:
13+
To use Toyplot you'll need the following (if you install Toyplot using pip,
14+
these are automatically installed for you):
15+
1416

1517
* Python 2.7 / Python 3 - http://python.org
1618
* colormath - https://github.com/gtaylor/python-colormath
@@ -20,8 +22,9 @@ To use Toyplot you'll need the following:
2022
PDF Export
2123
----------
2224

23-
If you intend to generate static PDF versions of your Toyplot figures, you'll need
24-
the following:
25+
To generate static PDF versions of your Toyplot figures, the following is
26+
required (if you install Toyplot using pip, it's automatically installed for
27+
you):
2528

2629
* ReportLab - open source PDF toolkit - http://www.reportlab.com/opensource/
2730

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Documentation
2727
ethos.rst
2828
features.rst
2929
compatibility.rst
30-
dependencies.rst
3130
installation.rst
31+
dependencies.rst
3232
tutorial.rst
3333
user-guide.rst
3434
contributing.rst

docs/installation.rst

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,23 @@
77
Installation
88
============
99

10-
Using Your OS Package Manager
10+
Using a Package Manager
1111
-----------------------------
1212

13-
Your operating system package manage manager (apt, yum, MacPorts, etc) should
14-
be your first stop for installing Toyplot - using your package manager will
15-
make it easy to install Toyplot and its dependencies, keep them up-to-date, and
16-
even (gasp!) uninstall them cleanly. If your package manager doesn't support
17-
Toyplot yet, drop them a line and let them know you'd like them to add it!
13+
A package manager (conda, apt, yum, MacPorts, etc) should generally be your
14+
first stop for installing Toyplot - it will make it easy to install Toyplot and
15+
its dependencies, keep them up-to-date, and even (gasp!) uninstall them
16+
cleanly. If your package manager doesn't support Toyplot yet, drop them a line
17+
and let them know you'd like them to add it!
18+
19+
If you're new to Python or unsure where to start, we strongly recommend taking
20+
a look at :ref:`Anaconda <anaconda-installation>`, which the Toyplot developers
21+
use during their day-to-day work.
1822

1923
.. toctree::
2024
:maxdepth: 2
2125

22-
conda-installation.rst
26+
anaconda-installation.rst
2327
freebsd-installation.rst
2428
macports-installation.rst
2529

@@ -28,13 +32,16 @@ Using Pip / Easy Install
2832

2933
If your package manager doesn't support Toyplot, or doesn't have the latest
3034
version, your next option should be Python setup tools like `pip`. You can
31-
always install the latest stable version of toyplot and its **required**
32-
:ref:`dependencies` with::
35+
always install the latest stable version of toyplot and its required
36+
dependencies using::
3337

3438
$ pip install toyplot
3539

36-
To install Toyplot's **optional** :ref:`dependencies`, you'll need to use a combination
37-
of pip and your system package manager.
40+
... following that, you'll be able to use all of Toyplot's features, and export
41+
figures to all of Toyplot's preferred file formats, including HTML, SVG, and PDF.
42+
43+
For export to other formats like PNG or MP4, you'll have to install additional resources
44+
listed in the :ref:`dependencies` section of the manual.
3845

3946
.. _From Source:
4047

@@ -48,5 +55,9 @@ you can install it using the source code::
4855
$ cd toyplot
4956
$ sudo python setup.py install
5057

51-
The setup script copies Toyplot into your Python site-packages directory, and
52-
it's ready to go.
58+
The setup script installs Toyplot's required dependencies and copies Toyplot into
59+
your Python site-packages directory, ready to go.
60+
61+
Once again, export to other formats like PNG or MP4, wil require additional resources
62+
listed in :ref:`dependencies`.
63+

docs/macports-installation.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,16 @@ Toyplot using pip::
1616
$ sudo port install py27-colormath
1717
$ sudo port install py27-multipledispatch
1818
$ sudo port install py27-numpy
19+
$ sudo port install py27-reportlab
1920
$ sudo port install py27-pip
2021
$ sudo port select --set pip pip27
2122
$ sudo pip install toyplot
2223

23-
If you want to generate PDF / PNG files using PyQt5::
24+
If you want to generate PNG files using PyQt5::
2425

2526
$ sudo port install py27-pyqt5
2627

27-
If you want to generate PDF / PNG files using cairo::
28+
If you want to generate PNG files using cairo::
2829

2930
$ sudo port install py27-pygtk
3031

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
"colormath",
2626
"multipledispatch",
2727
"numpy>=1.7",
28+
"reportlab",
2829
],
2930
long_description="""Toyplot is the kid-sized plotting toolkit for Python with grownup-sized goals:
3031
* Develop beautiful interactive, animated plots that embrace the unique capabilities of electronic publishing and support repoducibility.

0 commit comments

Comments
 (0)