Skip to content

Commit

Permalink
switch docs to flit
Browse files Browse the repository at this point in the history
  • Loading branch information
davidism committed Jun 27, 2023
1 parent 46b3288 commit 6b9acd5
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 32 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/on-create-command.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ set -e

python3 -m venv .venv
. .venv/bin/activate
pip install -U pip setuptools wheel
pip install -U pip
pip install -r requirements/dev.txt
pip install -e .
pre-commit install --install-hooks
2 changes: 1 addition & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ Released 2022-03-28
or ``AppContext.g`` instead. :issue:`3898`
- ``copy_current_request_context`` can decorate async functions.
:pr:`4303`
- The CLI uses ``importlib.metadata`` instead of ``setuptools`` to
- The CLI uses ``importlib.metadata`` instead of ``pkg_resources`` to
load command entry points. :issue:`4419`
- Overriding ``FlaskClient.open`` will not cause an error on redirect.
:issue:`3396`
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ First time setup in your local environment

.. code-block:: text
$ python -m pip install -U pip setuptools wheel
$ python -m pip install -U pip
$ pip install -r requirements/dev.txt && pip install -e .
- Install the pre-commit hooks.
Expand Down
4 changes: 2 additions & 2 deletions docs/patterns/packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ a big problem, just add a new file called :file:`pyproject.toml` next to the inn
]
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"
requires = ["flit_core<4"]
build-backend = "flit_core.buildapi"
Install your application so it is importable:

Expand Down
27 changes: 4 additions & 23 deletions docs/tutorial/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,30 +40,13 @@ The ``pyproject.toml`` file describes your project and how to build it.
]
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"
requires = ["flit_core<4"]
build-backend = "flit_core.buildapi"
The setuptools build backend needs another file named ``MANIFEST.in`` to tell it about
non-Python files to include.

.. code-block:: none
:caption: ``MANIFEST.in``
include flaskr/schema.sql
graft flaskr/static
graft flaskr/templates
global-exclude *.pyc
This tells the build to copy everything in the ``static`` and ``templates`` directories,
and the ``schema.sql`` file, but to exclude all bytecode files.

See the official `Packaging tutorial <packaging tutorial_>`_ and
`detailed guide <packaging guide_>`_ for more explanation of the files
and options used.
See the official `Packaging tutorial <packaging tutorial_>`_ for more
explanation of the files and options used.

.. _packaging tutorial: https://packaging.python.org/tutorials/packaging-projects/
.. _packaging guide: https://packaging.python.org/guides/distributing-packages-using-setuptools/


Install the Project
Expand Down Expand Up @@ -95,9 +78,7 @@ You can observe that the project is now installed with ``pip list``.
Jinja2 2.10
MarkupSafe 1.0
pip 9.0.3
setuptools 39.0.1
Werkzeug 0.14.1
wheel 0.30.0
Nothing changes from how you've been running your project so far.
``--app`` is still set to ``flaskr`` and ``flask run`` still runs
Expand Down
1 change: 0 additions & 1 deletion requirements/typing.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
mypy
types-contextvars
types-dataclasses
types-setuptools
cryptography
4 changes: 1 addition & 3 deletions requirements/typing.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SHA1:7cc3f64d4e78db89d81680ac81503d5ac35d31a9
# SHA1:6a354b832686fd3ec017455769a0270953a1e225
#
# This file is autogenerated by pip-compile-multi
# To update, run:
Expand All @@ -19,7 +19,5 @@ types-contextvars==2.4.7.2
# via -r requirements/typing.in
types-dataclasses==0.6.6
# via -r requirements/typing.in
types-setuptools==68.0.0.0
# via -r requirements/typing.in
typing-extensions==4.6.3
# via mypy

0 comments on commit 6b9acd5

Please sign in to comment.