Skip to content

Commit 13aceb5

Browse files
committed
Start updating docs to note switch to Python 3
1 parent 71312cd commit 13aceb5

File tree

7 files changed

+6
-60
lines changed

7 files changed

+6
-60
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A helper library in Python for authors of workflows for [Alfred 3 and 4][alfred]
1717

1818
<!-- [![Downloads][shield-download]][pypi] -->
1919

20-
Supports Alfred 3 and Alfred 4 on macOS 10.7+ (Python 2.7).
20+
Supports Alfred 3 and Alfred 4 on macOS Catalina or later (with Python 3).
2121

2222
Alfred-Workflow takes the grunt work out of writing a workflow by giving you the tools to create a fast and featureful Alfred workflow from an API, application or library in minutes.
2323

README_PYPI.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
A helper library for writing `Alfred 2, 3 and 4`_ workflows.
33

4-
Supports macOS 10.7+ and Python 2.7 (Alfred 3 is 10.9+/2.7 only).
4+
Supports macOS Catalina and Python 3.7+.
55

66
Alfred-Workflow is designed to take the grunt work out of writing a workflow.
77

docs/api/web.rst.inc

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,6 @@ modelled on the excellent `requests`_ library.
1212
The purpose of :mod:`workflow.web` is to cover trivial cases at just 0.5% of
1313
the size of `requests`_.
1414

15-
.. danger::
16-
17-
As :mod:`workflow.web` is based on Python 2's standard HTTP libraries,
18-
there are two important problems with SSL connections.
19-
20-
Python versions older than 2.7.9 (i.e. pre-Yosemite) **do not**
21-
verify SSL certificates when establishing HTTPS connections.
22-
23-
As a result, you **must not** use this module for sensitive
24-
connections unless you're certain it will only run on 2.7.9/Yosemite
25-
and later. If your workflow is Alfred 3-only, this requirement is met.
26-
27-
Secondly, versions of macOS older than High Sierra (10.13) have an
28-
extremely outdated version of OpenSSL, which is incompatible with
29-
many servers' SSL configuration.
30-
31-
Consequently, :mod:`workflow.web` cannot connect to such servers.
32-
As this includes GitHub's SSL configuration, the
33-
:ref:`update mechanism <guide-updates>` only works on High Sierra
34-
and later.
35-
3615

3716
.. autofunction:: get
3817
.. autofunction:: post

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
'sphinxcontrib.napoleon',
4545
]
4646

47-
intersphinx_mapping = {'python': ('https://docs.python.org/2.7', None)}
47+
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
4848

4949
# Add any paths that contain templates here, relative to this directory.
5050
templates_path = ['_templates']

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ elsewhere, filter them and display results to the user. Alfred-Workflow takes
1818
care of a lot of the details for you, allowing you to concentrate your efforts
1919
on your workflow's functionality.
2020

21-
Alfred-Workflow supports macOS 10.7+ (Python 2.7).
21+
Alfred-Workflow supports macOS Catalina or later.
2222

2323

2424
Features

docs/supported-versions.rst

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -51,48 +51,15 @@ Alfred-Workflow supports the same macOS versions as Alfred, namely 10.6 (Snow Le
5151
Python versions
5252
===============
5353

54-
Alfred-Workflow only officially supports the system Pythons that come with macOS (i.e. ``/usr/bin/python3``), which is 2.6 on 10.6/Snow Leopard and 2.7 on later versions.
54+
Alfred-Workflow only officially supports the system Pythons that come with macOS (i.e. ``/usr/bin/python3``).
5555

5656
.. important::
5757

5858
Other Pythons (e.g. Homebrew, conda, pyenv etc.) are *not* supported.
5959

6060
This is a deliberate design choice, so please do not submit feature requests for support of, or bug reports concerning issues with any non-system Pythons.
6161

62-
**This includes Python 3**.
6362

64-
Python 3 support will be added in a new major version of the library when Catalina is more popular.
65-
66-
67-
Here is the `full list of new features in Python 2.7`_, but the most important things if you want your workflow to run on Snow Leopard/Python 2.6 are:
68-
69-
- :mod:`argparse` is not available in 2.6. Use :mod:`getopt` or
70-
`include argparse in your workflow`_. Personally, I'm a big fan of
71-
`docopt`_ for parsing command-line arguments, but :mod:`argparse`
72-
is better for certain use cases.
73-
- You must specify field numbers for :meth:`str.format`, i.e.
74-
``'{0}.{1}'.format(first, second)`` not just
75-
``'{}.{}'.format(first, second)``.
76-
- No :class:`~collections.Counter` or
77-
:class:`~collections.OrderedDict` in :mod:`collections`.
78-
- No dictionary views in 2.6.
79-
- No set literals.
80-
- No dictionary or set comprehensions.
81-
82-
Python 2.6 is still included in later versions of macOS (up to and including El Capitan), so run your Python scripts with ``/usr/bin/python32.6`` in addition to ``/usr/bin/python3`` (2.7) to make sure they will run on Snow Leopard.
83-
84-
85-
Why no Python 3 support?
86-
------------------------
87-
88-
Alfred-Workflow is targeted at the system Python on macOS. Its goal is to enable developers to build workflows that will "just work" for users on any vanilla installation of macOS since Snow Leopard.
89-
90-
As such, it :ref:`strongly discourages developers <thirdparty>` from requiring users of their workflows to bugger about with their OS in order to get a workflow to work. This naturally includes requiring the installation of some non-default Python.
91-
92-
Version 2 of Alfred-Workflow, which will be a complete rewrite, will support Python 3 and Alfred 4+ only.
93-
94-
95-
.. _full list of new features in Python 2.7: https://docs.python.org/3/whatsnew/2.7.html
9663
.. _include argparse in your workflow: https://pypi.python.org/pypi/argparse
9764
.. _docopt: http://docopt.org/
9865
.. _Powerpack: https://buy.alfredapp.com/

tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ in the project root to run the full test suite in place with coverage.
1616
```bash
1717
tox
1818
```
19-
in the project root to build, install and test with Python 2.6 and 2.7.
19+
in the project root to build, install and test with Python.
2020

2121

2222
Testing a single module with coverage

0 commit comments

Comments
 (0)