diff --git a/doc/history.rst b/doc/history.rst index bc984129..e04e1fb6 100644 --- a/doc/history.rst +++ b/doc/history.rst @@ -1,10 +1,32 @@ Release history =============== -Unreleased ----------- +Version 3.8 +----------- -- Add support for recursive globbing (``**``) in sdist includes and excludes (:ghpull:`550`). +- A project name containing hyphens is now automatically translated to use + underscores for the import name (:ghpull:`566`). +- New option :option:`flit install --only-deps` to install the dependencies of + the package, but not the package itself. +- Add support for recursive globbing (``**``) in sdist includes and excludes + (:ghpull:`550`). +- Python's bytecode cache files (``__pycache__`` folders and ``.pyc`` files) + are now always excluded from sdists (:ghpull:`581`). +- Use tomllib in Python 3.11, rather than tomli (:ghpull:`573`, :ghpull:`604`). +- Fix crash when unable to get a password from ``keyring`` (:ghpull:`567`). +- Fix including modified files in sdist when using Mercurial (:ghpull:`541`). +- Fix for some cases of determining whether a package supports Python 2 or not + (:ghpull:`593`). +- Fix parsing version number from code using multiple assignments (:ghpull:`474`). +- Document how to use a PyPI token with :envvar:`FLIT_PASSWORD` (:ghpull:`602`). +- Fix link to information about environment variables for pip (:ghpull:`576`). +- Link to the docs for the latest stable version in package metadata + (:ghpull:`589`). +- Remove a mention of the ``toml`` package, which is no longer needed, from the + :doc:`development` page (:ghpull:`601`). +- The :doc:`bootstrap ` install script for ``flit_core`` accepts a + new ``--install-root`` option. +- Ensure the license file is included in packages on PyPI (:ghpull:`603`). Version 3.7.1 ------------- diff --git a/doc/pyproject_toml.rst b/doc/pyproject_toml.rst index 854cd7c6..18d1d26d 100644 --- a/doc/pyproject_toml.rst +++ b/doc/pyproject_toml.rst @@ -72,6 +72,10 @@ name this name, with any hyphens replaced by underscores, is also the default value of the import name (see :ref:`pyproject_module` if that needs to be different). + + .. versionchanged:: 3.8 + Hyphens in the project name are now translated to underscores for the + import name. version Version number as a string. If you want Flit to get this from a ``__version__`` attribute, leave it out of the TOML config and include @@ -414,12 +418,14 @@ These paths: - Must be relative paths from the directory containing ``pyproject.toml`` - Cannot go outside that directory (no ``../`` paths) - Cannot contain control characters or ``<>:"\\`` -- Cannot use recursive glob patterns (``**/``) - Can refer to directories, in which case they include everything under the directory, including subdirectories - Should match the case of the files they refer to, as case-insensitive matching is platform dependent +.. versionchanged:: 3.8 + Include and exclude patterns can now use recursive glob patterns (``**``). + Exclusions have priority over inclusions. Bytecode is excluded by default and cannot be included.