Skip to content

Commit 2dd1f04

Browse files
committed
Minor edits.
Removed reference to setup.py, since it's no longer used in v1.0
1 parent 704c23c commit 2dd1f04

1 file changed

Lines changed: 15 additions & 35 deletions

File tree

programmers-guide/source/index.rst

Lines changed: 15 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Introduction
1414
and *iCalendar* (aka *vCalendar*) objects, used for sharing and storage
1515
of personal contacts and calendar events.
1616

17-
It supports Python 2.7 in addition to Python 3.7 or later.
17+
It supports Python 3.8 or later. Releases in the 0.9.x series support
18+
Python 2.7, and earlier releases of Python 3.
1819

1920
This document gives an overview of the *vCard* and *iCalendar* standards,
2021
sufficient to begin using the package to generate or parse those that you
@@ -121,10 +122,10 @@ Or using their names to access them directly as attributes:
121122
3.0
122123
>>>
123124
124-
When accessed as directly named attributes of the parsed item,
125-
singleton properties *aren't* a list: you can access their valu If the
126-
child has parameters, in addition to its value, they are available as
127-
a dictionary:
125+
When accessed as named attributes of the parsed item, singleton
126+
properties *aren't* a list: you can access their value directly. If
127+
the child has parameters, in addition to its value, they are available
128+
as a dictionary:
128129
129130
.. code-block:: python
130131
:linenos:
@@ -146,7 +147,7 @@ vCards, for example:
146147
USA
147148
>>>
148149
149-
vObjects can be created by parsing (as above), by using a helper
150+
vObjects can be created by parsing (as above), or by using a helper
150151
function:
151152
152153
.. code-block:: python
@@ -234,7 +235,7 @@ useful to archive the source code for auditing or similar purposes.
234235
Installing a wheel
235236
~~~~~~~~~~~~~~~~~~
236237
If you've downloaded a *wheel* file (it should have a ``.whl`` suffix),
237-
you can install it using ``pip``:
238+
you can install it using ``pip`` as well:
238239
239240
.. code-block:: shell
240241
@@ -284,27 +285,6 @@ the ``-e`` parameter). An editable install directly uses the files in
284285
your checkout area, including any local modifications you've made at
285286
the time you imported the package.
286287
287-
Installing with setup.py (Deprecated)
288-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
289-
There should be no need to do this: use ``pip`` instead. But for
290-
completeness, you can directly call the ``setup.py`` script to build
291-
and install the package.
292-
293-
Activate the virtual environment to be used for development, and then,
294-
from the root directory of the source distribution, run:
295-
296-
.. code-block:: shell
297-
298-
python setup.py build
299-
python setup.py install
300-
301-
There are various arguments you can supply for ``setup.py``'s *install*
302-
command overriding the default install location. ``python setup.py
303-
install --help`` explains them.
304-
305-
This method is not officially supported, and will soon become obsolete
306-
as the Python ecosystem moves away from ``setup.py``.
307-
308288
309289
.. #####################################################################
310290
@@ -351,10 +331,11 @@ Calendars and Cards
351331
.. index:: Apple, AT&T, IBM, IETF, Internet Mail Consortium, Lucent, Siemens, Versit Consortium
352332
.. index:: vCard, vCalendar, iCalendar
353333
354-
The *vCard* and *vCalendar* specifications were originally developed by the
355-
Versit Consortium, with contributions from Apple, IBM, AT&T/Lucent, and
356-
Siemens. Their stewardship subsequently passed to the Internet Mail
357-
Consortium, before later being adopted by the IETF.
334+
The *vCard* and *vCalendar* specifications were originally developed
335+
by the Versit Consortium (and that's why they're named with a leading
336+
"v"), with contributions from Apple, IBM, AT&T/Lucent, and Siemens.
337+
Their stewardship subsequently passed to the Internet Mail Consortium,
338+
before the standards were later adopted by the IETF.
358339
359340
Within the IETF, vCard versions 3.0 and 4.0, and a revised and expanded
360341
calendar specification renamed to *iCalendar* 2.0 have been published,
@@ -401,7 +382,7 @@ exist, as well as HTML microformats.
401382
402383
More recent work in the IETF is looking to revise the semantic models
403384
of vCard and iCalendar, proposing new standards that can be translated
404-
to and from vCard and iCalendar, but add additional functionality.
385+
to and from vCard and iCalendar, but add extra functionality.
405386
406387
vObject
407388
-------
@@ -884,8 +865,7 @@ Getting Help
884865
885866
.. epigraph::
886867
887-
95=17|96=RAW DATA \\x00\\x01 VALUE|
888-
868+
TBD
889869
890870
.. _GitHub: https://github.com/py-vobject/vobject
891871
.. _Python: http://www.python.org/

0 commit comments

Comments
 (0)