Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adopt pyproject.toml standard, fast-forward cookiecutter #50

Merged
merged 20 commits into from
Nov 30, 2023

Conversation

Zeitsperre
Copy link
Collaborator

@Zeitsperre Zeitsperre commented Nov 22, 2023

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • HISTORY.rst has been updated (with summary of main changes).
    • Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

  • Uses the latest cookiecutter template
  • Replaces setup.py, MANIFEST.in, and configs in the setup.cfg for pyproject.toml and .flake8
  • Most flake8 checks are now handled via ruff
  • New GitHub Workflows for automatically managing version bump and actions versions.
  • Documentation adjustments

Does this PR introduce a breaking change?

Yes. We now are using pyproject.toml with flit to build the library. This will entail one or two major changes to a typical development workflow.

The main changes worth noting:

  • $ pip install -e . should be substituted for $ flit install -s/--symlink . when performing development installations ($ pip install . works exactly as you'd expect).
    • Alternatively, one can run $ make develop. This is documented.
  • Most configurations are now found within the pyproject.toml

Other information:

https://flit.pypa.io/en/stable/index.html
https://peps.python.org/pep-0518/
https://peps.python.org/pep-0621/
https://www.mypy-lang.org/

@Zeitsperre Zeitsperre added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 22, 2023
@Zeitsperre Zeitsperre self-assigned this Nov 22, 2023
@Zeitsperre Zeitsperre marked this pull request as ready for review November 22, 2023 22:20
.github/workflows/main.yml Outdated Show resolved Hide resolved
CONTRIBUTING.rst Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Show resolved Hide resolved
docs/installation.rst Outdated Show resolved Hide resolved
docs/installation.rst Outdated Show resolved Hide resolved
docs/installation.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
Co-authored-by: RondeauG <38501935+RondeauG@users.noreply.github.com>
@RondeauG RondeauG self-requested a review November 29, 2023 22:14
Copy link
Collaborator

@RondeauG RondeauG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job, thanks!

@RondeauG
Copy link
Collaborator

We'll need to modify PULL_REQUEST_TEMPLATE.md to refer to CHANGES.rst, instead of HISTORY.rst

@Zeitsperre Zeitsperre merged commit f7afdb0 into main Nov 30, 2023
10 of 11 checks passed
@Zeitsperre Zeitsperre deleted the cruft-update branch November 30, 2023 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mettre à jour les instructions d'installation
2 participants