Skip to content

Commit 9e3a9cc

Browse files
committed
docs: improve docs
1 parent c3ed33b commit 9e3a9cc

File tree

2 files changed

+35
-16
lines changed

2 files changed

+35
-16
lines changed

README.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
.. image:: https://travis-ci.org/scanny/python-pptx.svg?branch=master
2-
:target: https://travis-ci.org/scanny/python-pptx
3-
4-
*python-pptx* is a Python library for creating and updating PowerPoint (.pptx)
1+
*python-pptx* is a Python library for creating, reading, and updating PowerPoint (.pptx)
52
files.
63

7-
A typical use would be generating a customized PowerPoint presentation from
8-
database content, downloadable by clicking a link in a web application.
9-
Several developers have used it to automate production of presentation-ready
10-
engineering status reports based on information held in their work management
11-
system. It could also be used for making bulk updates to a library of
12-
presentations or simply to automate the production of a slide or two that
13-
would be tedious to get right by hand.
4+
A typical use would be generating a PowerPoint presentation from dynamic content such as
5+
a database query, analytics output, or a JSON payload, perhaps in response to an HTTP
6+
request and downloading the generated PPTX file in response. It runs on any Python
7+
capable platform, including macOS and Linux, and does not require the PowerPoint
8+
application to be installed or licensed.
9+
10+
It can also be used to analyze PowerPoint files from a corpus, perhaps to extract search
11+
indexing text and images.
12+
13+
In can also be used to simply automate the production of a slide or two that would be
14+
tedious to get right by hand, which is how this all got started.
1415

1516
More information is available in the `python-pptx documentation`_.
1617

docs/index.rst

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,21 @@ Release v\ |version| (:ref:`Installation <install>`)
77
.. include:: ../README.rst
88

99

10+
Philosophy
11+
----------
12+
13+
|pp| aims to broadly support the PowerPoint format (PPTX, PowerPoint 2007 and later),
14+
but its primary commitment is to be _industrial-grade_, that is, suitable for use in a
15+
commercial setting. Maintaining this robustness requires a high engineering standard
16+
which includes a comprehensive two-level (e2e + unit) testing regimen. This discipline
17+
comes at a cost in development effort/time, but we consider reliability to be an
18+
essential requirement.
19+
20+
1021
Feature Support
1122
---------------
1223

13-
|pp| has the following capabilities, with many more on the roadmap:
24+
|pp| has the following capabilities:
1425

1526
* Round-trip any Open XML presentation (.pptx file) including all its elements
1627
* Add slides
@@ -21,11 +32,18 @@ Feature Support
2132
* Add auto shapes (e.g. polygons, flowchart shapes, etc.) to a slide
2233
* Add and manipulate column, bar, line, and pie charts
2334
* Access and change core document properties such as title and subject
35+
* And many others ...
36+
37+
Even with all |pp| does, the PowerPoint document format is very rich and there are still
38+
features |pp| does not support.
39+
40+
41+
New features/releases
42+
---------------------
2443

25-
Additional capabilities are actively being developed and added on a release
26-
cadence of roughly once per month. If you find a feature you need that |pp|
27-
doesn't yet have, reach out via the mailing list or issue tracker and we'll see
28-
if we can jump the queue for you to pop it in there :)
44+
New features are generally added via sponsorship. If there's a new feature you need for
45+
your use case, feel free to reach out at the email address on the github.com/scanny
46+
profile page. Many of the most used features such as charts were added this way.
2947

3048

3149
User Guide

0 commit comments

Comments
 (0)