update project files #257
update project files #257
Conversation
use standard project layout and tool config across all pallets and pallets-eco projects * add issue templates * add dependabot grouped updates for actions and pypi * add lock inactive closed issues workflow * add publish workflow with slsa and trusted publishing * simplify tests workflow matrix * simplify docs config.py * show license in docs * use pip-compile to pin development dependencies * rename test to tests * add .editorconfig * simplify .gitignore * add pre-commit hooks (will run formatters in a subsequent PR) * pin os and python in .readthedocs.yaml * update license with original commit date and pallets-eco * use pyproject.toml and flit_core instead of setuptools * only declare flask dependency * add config for mypy and pyright (will add typing in a subsequent PR) * readme is markdown * add pallets-eco message to readme * remove install and docs links from readme * add style, typing, docs tox envs * use faster wheel building tox config * add tox command to update dev dependencies
|
I'll be running |
|
This adds our standard publish workflow. In the future, creating a "release version N" PR and pushing a tag will trigger the workflow, which requires a review from a maintainer before uploading to PyPI using trusted publishing. |
|
I realize this is impossible to review, but it's the same as every other Pallets project. I'm happy to answer any questions about what we use. |
|
What do you think about keeping the original author's copyright line item in the LICENSE file? The current commit replaces |
|
My understanding is that this describes the copyright holder, not the original author. Pallets (described as the Pallets Community Ecosystem here for pallets-eco) hold the copyright since the project was transferred to us (as opposed to us forking the project into a separate one). Rob was also not the original author of Flask-DebugToolbar, but of django-debug-toolbar which it was based on. I can find no clear or consistent guidance from reliable sources about how this works in legal practice, but my instinct is to make it reflect the current state of the project. This is also what we did for the Pallets projects themselves years ago when they were transferred to Pallets. |
| - Add tests that demonstrate the correct behavior of the change. Tests | ||
| should fail without the change. | ||
| - Add or update relevant docs, in the docs folder and in code. | ||
| - Add an entry in CHANGES.rst summarizing the change and linking to the issue. |
There was a problem hiding this comment.
We currently don't have a CHANGES.rst in this repo:
| author = [{ name = "Michael van Tellingen" }] | ||
| maintainers = [{ name = "Pallets Ecosystem", email = "contact@palletsprojects.com" }] | ||
| classifiers = [ | ||
| "Development Status :: 4 - Beta", |
There was a problem hiding this comment.
Probably about time we move this out of Beta status 😁
There was a problem hiding this comment.
Yes, we should also think about what 1.0 looks like.
One of my goals with Pallets-Eco is to standardize and document how our projects
are organized and maintained. Using a standard layout and tool config across all
projects makes it much easier for anyone familiar with one project to jump in to
help another, and makes it easier to write one set of maintainer documentation
for all.
This is a general update to more closely match how the Pallets projects are laid
out. We try to use a minimal set of common tools without much custom config.
I've pre-squashed the commits, see pallets/flask#5457 with each commit split out
in the PR.
This also adds a message to the readme to inform potential contributors about
Pallets-Eco and how they can get involved.