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

feat(template): Adding setuptools as a build-system option #140

Merged
merged 6 commits into from
Jul 4, 2023

Conversation

Anavelyz
Copy link
Collaborator

@Anavelyz Anavelyz commented Jul 4, 2023

Pull Request description

  • Adding documentation about setuptools.
  • Enable option in TUI for setuptools.
  • Adding setuptools as a build-system:
    • Creating a setuptools-pyproject.toml.
    • Editing post_gen_project.py.
    • Editing cookiecutter.json.
    • Editing Makefile of the template.
    • Adding setuptools in conda/dev.yaml.
    • Adding setuptools to build-system.sh
    • Adding code to base.sh to check if the setuptools command is available in the system.
  • Standardize the use of literal strings within the template with double quotes.
  • Adding noqa in profile.py to ignore ruff warnings

Solve #53

Pull Request checklists

This PR is a:

  • bug-fix
  • new feature
  • maintenance

About this PR:

  • it includes tests.
  • the tests are executed on CI.
  • the tests generate log file(s) (path).
  • pre-commit hooks were executed locally.
  • this PR requires a project documentation update.

Author's checklist:

  • I have reviewed the changes and it contains no misspelling.
  • The code is well commented, especially in the parts that contain more complexity.
  • New and old tests passed locally.

Reviewer's Checklist

  • I managed to reproduce the problem locally from the main branch
  • I managed to test the new changes locally
  • I confirm that the issues mentioned were fixed/resolved.

@Anavelyz
Copy link
Collaborator Author

Anavelyz commented Jul 4, 2023

@xmnlab In tests/smoke/base.sh there is the same for setuptools as in meson, do I leave it as it is now or change it to pip install -e .?

@Anavelyz Anavelyz requested a review from xmnlab July 4, 2023 15:20
@xmnlab
Copy link
Member

xmnlab commented Jul 4, 2023

@xmnlab In tests/smoke/base.sh there is the same for setuptools as in meson, do I leave it as it is now or change it to pip install -e .?

feel free to keep it .. as both are the same .. it is not a problem .. thanks

@xmnlab
Copy link
Member

xmnlab commented Jul 4, 2023

@Anavelyz in general looks good to me.
the only problem now is that there is no setuptools command: https://github.com/osl-incubator/scicookie/actions/runs/5456097301/jobs/9928662242?pr=140#step:5:1820
and for that reason it cannot install the command with pip

as setuptool is kind the legacy because in the past we just used to use setuptools and maybe also it is used as dependency for the other build-system, let's use it in the else case. and maybe add a comment there ... I will add a comment direct in the file as well

tests/smoke/base.sh Outdated Show resolved Hide resolved
Co-authored-by: Ivan Ogasawara <ivan.ogasawara@gmail.com>
@xmnlab xmnlab merged commit 4cd11c0 into osl-incubator:main Jul 4, 2023
@xmnlab
Copy link
Member

xmnlab commented Jul 4, 2023

thanks @Anavelyz

@Anavelyz
Copy link
Collaborator Author

Anavelyz commented Jul 4, 2023

@xmnlab In the future, for setuptools, we can add the options to configure it through setup.cfg or setup.py.

@xmnlab
Copy link
Member

xmnlab commented Jul 4, 2023

@Anavelyz I hear you, but my impression is that the community is trying to kill setuptools ... so maybe first it would be nice to see if it would be worthy or not
although setuptools is still used massively

@github-actions
Copy link

github-actions bot commented Jul 5, 2023

🎉 This PR is included in version 0.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants