| Commit message (Collapse) | Author | Age | Files | Lines | ||
|---|---|---|---|---|---|---|
| ... | ||||||
| | * | | Elaborated on first example involving `include_package_data` | Saniya Maheshwari | 2022-05-25 | 1 | -7/+27 | |
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Have tried to make the working of the `include_package_data` option as clear as possible. - Added a package tree - Tried to clearly state that the data files must be either included in `MANIFEST.in`, or tracked by a VCS, in order for them to be included in the installation of the package, when `include_package_data=True`. - Added a `MANIFEST.in` snippet to make things more clear. | |||||
| | * | | Changes to the User Guide's Data Files page | Saniya Maheshwari | 2022-05-24 | 1 | -73/+251 | |
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - All code snippets were given for `setup.py`. Have added corresponding snippets for `setup.cfg` and `pyproject.toml`. - To avoid incentivizing multiple top-level packages, have modified all the package trees and code snippets to include only a single package `mypkg`. Have added a separate example to illustrate the functionality of using the empty string `""` / the asterisk `*` for capturing data files from multiple packages. Have also modified the `setup.py` code snippets and removed the `find_packages("src")` since there is only a single package in each case (except one); have opted to explicitly name the package instead. - Have added a package tree example for the first `package_data` snippet. Have also added a package tree / code snippet example to show how `package_data` patterns should include subdirectories, separating it from the example showing the empty string `""` / asterisk `*` functionality. - Tried to have consistent naming for all directories and data files used in the package trees and code snippets. All directories have been named `mypkg` and data files have been named `data1.txt`, `data2.rst` etc. - Have reformatted package tree examples. Reformatting has been done by replacing the only-indentation based directory structure diagram with a line-based tree layout; I think this looks neater. - Have added `.. note::` blocks for paragraphs that would be more appropriately phased as a Note. Other minor changes to text content have been made. | |||||
| * | | | Missing the word "pyproject.toml" in Quickstart. | Michael Loyd | 2022-05-24 | 1 | -1/+1 | |
| |/ / | | | | | In the sentence "If you are experimenting with configuration using, or have version of..." | |||||
| * | | Avoid incentivizing multi-package distributions | Anderson Bravalheri | 2022-05-20 | 1 | -38/+50 | |
| | | | ||||||
| * | | Typo fix | Saniya Maheshwari | 2022-05-20 | 1 | -1/+1 | |
| | | | ||||||
| * | | Added two `mypkg` directories in the example directory trees | Saniya Maheshwari | 2022-05-20 | 1 | -4/+12 | |
| | | | | | | | | | | | | | | | | | | | Since the previous example on manually specifying `packages` and `package_dir` alludes to two packages, `mypkg1` and `mypkg2`, IMHO it would be more consistent to continue this and show two packages in the directory trees for the src-layout and flat-layout, instead of showing a single package `mypkg`. This would also make it more clear that multiple packages are allowed. | |||||
| * | | Grammar errors | Saniya Maheshwari | 2022-05-20 | 1 | -14/+14 | |
| | | | ||||||
| * | | Add deprecation messages for `namespace_packages` (#3262) | Anderson Bravalheri | 2022-05-16 | 2 | -2/+6 | |
| |\ \ | ||||||
| | * | | Add deprecation notices to docs | Anderson Bravalheri | 2022-05-16 | 2 | -2/+6 | |
| | | | | ||||||
| * | | | Warn about deprecation of behaviour that considers modules/packages as data ↵ | Anderson Bravalheri | 2022-05-16 | 1 | -1/+1 | |
| |\ \ \ | |/ / |/| | | | | | when include_package_data=True (#3308) | |||||
| | * | | Quickfix missing comment mark in docs | Anderson Bravalheri | 2022-05-05 | 1 | -1/+1 | |
| | | | | ||||||
| * | | | Clarify that `pyproject.toml` config will not be removed (#3295) | Anderson Bravalheri | 2022-05-16 | 4 | -5/+5 | |
| |\ \ \ | ||||||
| | * | | | Clarify that `pyproject.toml` config will not be removed | Jim Garrison | 2022-04-29 | 4 | -5/+5 | |
| | |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The current documentation regarding `pyproject.toml` claims that support for using it to specify package metadata and build configuration options might be "completely removed" in a future release. However, nowadays it is clear (https://github.com/pypa/setuptools/issues/1688#issuecomment-1079706929 and #3214) that `pyproject.toml` is not going anywhere, is here to stay, and is in fact expected to be the preferred format in the future. This makes an incremental change toward that future by clarifying that `pyproject.toml` support will not be removed in a future release of setuptools. | |||||
| * | | | Move userguide/keywords to deprecated/changed_keyworkds | Anderson Bravalheri | 2022-05-06 | 3 | -114/+1 | |
| | | | | ||||||
| * | | | Make the separation between distutils and setuptools keywords more clear | Anderson Bravalheri | 2022-05-06 | 1 | -53/+62 | |
| | | | | | | | | | | | | | | | | | | | | | | The biggest value of retaining the `userguide/keywords` document is to retain information about which keywords have changed. Therefore it makes sense to preserve (and highlight) that information. | |||||
| * | | | redirect userguide keywords to references keywords | Jeremy Paige | 2022-05-05 | 1 | -161/+101 | |
| |/ / | ||||||
| * | | Update package_discovery.rst | Binjian | 2022-04-22 | 1 | -1/+1 | |
| | | | | | | | double "can be" | |||||
| * | | Fix typo in docs | Vladimir Berlev | 2022-04-14 | 1 | -1/+1 | |
| |/ | ||||||
| * | Small wording tweaks for readability | Chuck McCallum | 2022-04-05 | 1 | -4/+4 | |
| | | ||||||
| * | Fix typo in quickstart section | Pablo Cárdenas | 2022-03-26 | 1 | -1/+1 | |
| | | | | | | The function should be between quotes like a string. cli-name = mypkg.mymodule:some_func => cli-name = "mypkg.mymodule:some_func" | |||||
| * | Fix `bellow` typo in docs | Mathieu Kniewallner | 2022-03-24 | 3 | -5/+5 | |
| | | ||||||
| * | Add back notes about editable install and pyproject metadata | Anderson Bravalheri | 2022-03-24 | 2 | -1/+29 | |
| | | | | | On further examination, `pip` seems to fail if `setup.py` is missing. | |||||
| * | Fix wrong version reference in quickstart | Anderson Bravalheri | 2022-03-24 | 1 | -1/+1 | |
| | | ||||||
| * | Clarify that only deprecated fields should be avoided in pyproject_config | Anderson Bravalheri | 2022-03-24 | 1 | -2/+2 | |
| | | ||||||
| * | Remove note about setup.py being required for editable installs | Anderson Bravalheri | 2022-03-24 | 1 | -5/+0 | |
| | | ||||||
| * | Improve note about setup.py | Anderson Bravalheri | 2022-03-24 | 1 | -1/+2 | |
| | | ||||||
| * | Add missing preposition | Anderson Bravalheri | 2022-03-24 | 1 | -1/+1 | |
| | | ||||||
| * | Add module to entry_point example in quickstart | Anderson Bravalheri | 2022-03-24 | 1 | -4/+4 | |
| | | ||||||
| * | Improve text about CLI entry-point in quickstart | Anderson Bravalheri | 2022-03-24 | 1 | -2/+3 | |
| | | ||||||
| * | Fix example of environment maker for dependencies in quickstart | Anderson Bravalheri | 2022-03-24 | 1 | -1/+1 | |
| | | ||||||
| * | Restore tip about editable installs | Anderson Bravalheri | 2022-03-24 | 1 | -20/+3 | |
| | | | | | | Experiments with pip 21.1 confirm that it can use editable mode even when `setup.py` is missing. | |||||
| * | Adequate docs to the latest changes | Anderson Bravalheri | 2022-03-22 | 1 | -1/+5 | |
| | | ||||||
| * | Update discovery docs to mention ext_modules | Anderson Bravalheri | 2022-03-22 | 1 | -2/+2 | |
| | | ||||||
| * | Merge 'upstream/main' into experimental/support-pyproject | Anderson Bravalheri | 2022-03-21 | 2 | -3/+3 | |
| |\ | ||||||
| | * | Fix warnings for pypi references. | Jason R. Coombs | 2022-03-19 | 3 | -4/+4 | |
| | | | ||||||
| * | | Change tabs in discovery docs to be similar to quickstart | Anderson Bravalheri | 2022-03-18 | 1 | -15/+5 | |
| | | | ||||||
| * | | Update package discovery docs to reflect latest changes | Anderson Bravalheri | 2022-03-18 | 1 | -29/+35 | |
| | | | ||||||
| * | | Clarify directives in the context of pyproject.toml | Anderson Bravalheri | 2022-03-17 | 1 | -4/+12 | |
| | | | ||||||
| * | | Small doc improvements | Anderson Bravalheri | 2022-03-17 | 2 | -16/+17 | |
| | | | ||||||
| * | | Apply suggestions from code review | Anderson Bravalheri | 2022-03-17 | 2 | -4/+4 | |
| | | | | | | | Co-authored-by: Steven Silvester <steven.silvester@ieee.org> | |||||
| * | | Add notes to pyproject_config docs | Anderson Bravalheri | 2022-03-17 | 1 | -0/+2 | |
| | | | ||||||
| * | | Clarify extras in entry-points are deprecated | Anderson Bravalheri | 2022-03-17 | 2 | -45/+50 | |
| | | | ||||||
| * | | Add tab for pyproject.toml in dependency management docs | Anderson Bravalheri | 2022-03-17 | 1 | -3/+76 | |
| | | | ||||||
| * | | Fix references to layouts in docs | Anderson Bravalheri | 2022-03-17 | 1 | -42/+49 | |
| | | | ||||||
| * | | Improve notes on quickstart | Anderson Bravalheri | 2022-03-17 | 1 | -37/+47 | |
| | | | ||||||
| * | | Clarify editable installs note in quickstart | Anderson Bravalheri | 2022-03-17 | 1 | -21/+22 | |
| | | | ||||||
| * | | Add note about editable installs in quickstart | Anderson Bravalheri | 2022-03-17 | 1 | -1/+17 | |
| | | | ||||||
| * | | Improve data files section in quickstart | Anderson Bravalheri | 2022-03-17 | 1 | -3/+27 | |
| | | | ||||||
| * | | Improve dependencies section in quickstart | Anderson Bravalheri | 2022-03-17 | 1 | -16/+41 | |
| | | | ||||||
| * | | Improve entry-points section in the quickstart | Anderson Bravalheri | 2022-03-17 | 1 | -11/+37 | |
| | | | ||||||
