Feat(template): Added scikit as an option for build system #161

ayeankit · 2023-07-31T19:05:29Z

Pull Request description

Fixes #71

Activate option in TUI to maturin
Adding documentation about scikit
Adding scikit as a build-system:
Creating a scikit-pyproject.toml
Editing post_gen_project.py
Creating a smoke test (build-system.sh)
Editing cookicutter.json
Added scikit in Readme.md

How to test these changes

...

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.

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## 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 .

xmnlab · 2023-07-31T19:38:09Z

@ayeankit I just merged 2 PRs, could you rebase your branch on top of upstream/main pls?

xmnlab · 2023-07-31T19:42:01Z

could you check if you are using the instructions from here?
https://scikit-build.readthedocs.io/en/latest/

ayeankit · 2023-07-31T19:52:10Z

could you check if you are using the instructions from here? https://scikit-build.readthedocs.io/en/latest/

yes, I am using official docs for reference. Thank you for asking.

README.md

xmnlab

@ayeankit thanks for working on that!
in general it looks good.
please change the references (names, links etc) from just scikit to scikit-build, also replace the references from scikit-hep by scikit-build

xmnlab · 2023-07-31T19:55:33Z

docs/guide.md

@@ -325,7 +325,14 @@ packages. SciCookie support the following:
  compatibility with setuptools and Cargo make it an easy-to-use tool, offering
  developers a simple solution to combine the strengths of Python and Rust within
  a unified project.
-
+- [**scikit**](https://scikit-hep.org):It's build system designed for Python


same thing here about scikit-build and https://scikit-build.readthedocs.io/

xmnlab · 2023-07-31T19:57:56Z

src/scicookie/{{cookiecutter.project_slug}}/docs/contributing.md

@@ -56,6 +56,9 @@ In addition, you should know that to build our package we use
 {%- elif cookiecutter.build_system == "maturin" -%}
 In addition, you should know that to build our package we use
 [Maturin](https://pypi.org/project/maturin/0.8.2/):It's a Python packaging tool and build system for creating Python bindings from Rust projects. It enables seamless integration of Rust code into Python applications, offering efficient builds, cross-platform support, and compatibility with different Python versions. Maturin automates the process of generating Python modules that directly call Rust functions, leveraging Rust's performance and low-level capabilities in Python. With its easy-to-use interface and integration with setuptools and Cargo, Maturin provides a straightforward solution for developers seeking to combine the strengths of Python and Rust in a single project.
+{%- elif cookiecutter.build_system == "maturin" -%}


probably this should be scikit-build

src/scicookie/cookiecutter.json

src/scicookie/hooks/post_gen_project.py

src/scicookie/profiles/base.yaml

src/scicookie/{{cookiecutter.project_slug}}/conda/dev.yaml

xmnlab · 2023-07-31T20:00:04Z

src/scicookie/{{cookiecutter.project_slug}}/docs/contributing.md

@@ -56,6 +56,9 @@ In addition, you should know that to build our package we use
 {%- elif cookiecutter.build_system == "maturin" -%}
 In addition, you should know that to build our package we use
 [Maturin](https://pypi.org/project/maturin/0.8.2/):It's a Python packaging tool and build system for creating Python bindings from Rust projects. It enables seamless integration of Rust code into Python applications, offering efficient builds, cross-platform support, and compatibility with different Python versions. Maturin automates the process of generating Python modules that directly call Rust functions, leveraging Rust's performance and low-level capabilities in Python. With its easy-to-use interface and integration with setuptools and Cargo, Maturin provides a straightforward solution for developers seeking to combine the strengths of Python and Rust in a single project.
+{%- elif cookiecutter.build_system == "maturin" -%}
+In addition, you should know that to build our package we use
+[scikit-hep](https://scikit-hep.org):It's a Python packaging tool and build system an improved build system generator for CPython C extensions. It provides better support for additional compilers, build systems, cross compilation, and locating dependencies and their associated build requirements.This tool improves package management in the scientific Python ecosystem, enabling cross-platform builds with CMake, and seamless integration with C/C++ libraries for research software engineers.


change scikit-hep to scikit-build text and refs, please

tests/smoke/build-system.sh

Co-authored-by: Ivan Ogasawara <[email protected]>

docs/guide.md

Co-authored-by: Ivan Ogasawara <[email protected]>

Saransh-cpp

Thanks, @ayeankit! This PR confuses scikit-build with scikit-build-core. I can see that you use scikit-build-core in pyproject.toml, but you are calling it scikit-build everywhere in this PR. scikit-build and scikit-build-core are technically different build backends.

ayeankit · 2023-07-31T20:44:01Z

Thanks, @ayeankit! This PR confuses scikit-build with scikit-build-core. I can see that you use scikit-build-core in pyproject.toml, but you are calling it scikit-build everywhere in this PR. scikit-build and scikit-build-core are technically different build backends.

Thanks @Saransh-cpp , so should I change scikit-build to scikit-build-core, as scikit-build uses setup.py and scikit-build-core uses main.cpp.And I here uses main.cpp method.

Saransh-cpp · 2023-07-31T20:51:39Z

We should ideally have both of them in scicookie. Given that you have already done most of the stuff keeping scikit-build-core in mind as the backend, you can switch all the text references to scikit-build-core.

ayeankit · 2023-08-01T17:03:18Z

@xmnlab Can you please review it once again?

docs/guide.md

src/scicookie/cookiecutter.json

src/scicookie/hooks/post_gen_project.py

src/scicookie/profiles/base.yaml

src/scicookie/{{cookiecutter.project_slug}}/conda/dev.yaml

src/scicookie/{{cookiecutter.project_slug}}/docs/contributing.md

tests/smoke/build-system.sh

Co-authored-by: Saransh Chopra <[email protected]>

ayeankit · 2023-08-01T19:37:01Z

Hey @Saransh-cpp , I think there needs to be one more PR for scikit-build with using scikit-buildas backend for build-system.

Saransh-cpp · 2023-08-01T19:44:49Z

Yes!

Saransh-cpp

It would make sense to explicitly use scikit-build-core everywhere, given that you plan to add scikit-build as a backend too.

src/scicookie/hooks/post_gen_project.py

Saransh-cpp · 2023-08-01T19:46:14Z

src/scicookie/{{cookiecutter.project_slug}}/build-system/scikit-pyproject.toml

Rename scikit-build-core-pyproject.toml

src/scicookie/{{cookiecutter.project_slug}}/build-system/skcdemo.cpp

tests/smoke/base.sh

Co-authored-by: Saransh Chopra <[email protected]>

…mo.cpp Co-authored-by: Saransh Chopra <[email protected]>

Co-authored-by: Saransh Chopra <[email protected]>

src/scicookie/hooks/post_gen_project.py

src/scicookie/{{cookiecutter.project_slug}}/conda/dev.yaml

tests/smoke/base.sh

Co-authored-by: Ivan Ogasawara <[email protected]>

xmnlab

thanks for working on that @ayeankit !
@Saransh-cpp thank you so much for the review!

github-actions · 2023-08-09T12:17:29Z

🎉 This PR is included in version 0.5.0 🎉

The release is available on:

0.5.0
GitHub release

Your semantic-release bot 📦🚀

ayeankit added 2 commits August 1, 2023 00:31

added scikit as build system

a9976e3

updated cmkaefile

7d18315

ayeankit force-pushed the scikit branch from 0a10a70 to 7d18315 Compare July 31, 2023 19:11

ayeankit added 2 commits August 1, 2023 01:15

Merge branch 'main' into scikit

fe4de63

docs/guide

670f84f

ayeankit force-pushed the scikit branch from e0cab76 to 670f84f Compare July 31, 2023 19:48

xmnlab reviewed Jul 31, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

xmnlab requested changes Jul 31, 2023

View reviewed changes

ayeankit and others added 11 commits August 1, 2023 01:34

Update src/scicookie/cookiecutter.json

118317b

Co-authored-by: Ivan Ogasawara <[email protected]>

Update src/scicookie/hooks/post_gen_project.py

3fb6f3d

Co-authored-by: Ivan Ogasawara <[email protected]>

Update tests/smoke/build-system.sh

3e684d3

Co-authored-by: Ivan Ogasawara <[email protected]>

Update src/scicookie/{{cookiecutter.project_slug}}/conda/dev.yaml

d674559

Co-authored-by: Ivan Ogasawara <[email protected]>

Update src/scicookie/profiles/base.yaml

b0e881a

Co-authored-by: Ivan Ogasawara <[email protected]>

Update src/scicookie/hooks/post_gen_project.py

37ffe18

Co-authored-by: Ivan Ogasawara <[email protected]>

Update README.md

d1bb3a1

Co-authored-by: Ivan Ogasawara <[email protected]>

Update src/scicookie/hooks/post_gen_project.py

cd818ee

Co-authored-by: Ivan Ogasawara <[email protected]>

Update contributing.md

1d20b2a

Update guide.md

090b30a

Update contributing.md

ae0ca92

xmnlab reviewed Jul 31, 2023

View reviewed changes

docs/guide.md Outdated Show resolved Hide resolved

Update docs/guide.md

e2e3058

Co-authored-by: Ivan Ogasawara <[email protected]>

Saransh-cpp requested changes Jul 31, 2023

View reviewed changes

ayeankit added 3 commits August 1, 2023 22:26

changes scikit-build to scikit-build-core

4c58451

Update guide.md

19e6f2e

Update contributing.md

29b6d11

Saransh-cpp requested changes Aug 1, 2023

View reviewed changes

ayeankit and others added 9 commits August 2, 2023 01:02

Update docs/guide.md

ec0a7dc

Co-authored-by: Saransh Chopra <[email protected]>

Update src/scicookie/cookiecutter.json

d9bf0c7

Co-authored-by: Saransh Chopra <[email protected]>

Update src/scicookie/hooks/post_gen_project.py

9b459a3

Co-authored-by: Saransh Chopra <[email protected]>

Update src/scicookie/hooks/post_gen_project.py

e269533

Co-authored-by: Saransh Chopra <[email protected]>

Update tests/smoke/build-system.sh

8f339d2

Co-authored-by: Saransh Chopra <[email protected]>

Update src/scicookie/profiles/base.yaml

6056976

Co-authored-by: Saransh Chopra <[email protected]>

Update src/scicookie/{{cookiecutter.project_slug}}/conda/dev.yaml

ef84562

Co-authored-by: Saransh Chopra <[email protected]>

Update src/scicookie/{{cookiecutter.project_slug}}/docs/contributing.md

1000c35

Co-authored-by: Saransh Chopra <[email protected]>

Update src/scicookie/{{cookiecutter.project_slug}}/docs/contributing.md

022bc95

Co-authored-by: Saransh Chopra <[email protected]>

Saransh-cpp requested changes Aug 1, 2023

View reviewed changes

ayeankit and others added 6 commits August 2, 2023 01:20

Update tests/smoke/base.sh

0e16a7d

Co-authored-by: Saransh Chopra <[email protected]>

Update src/scicookie/hooks/post_gen_project.py

841a613

Co-authored-by: Saransh Chopra <[email protected]>

Update src/scicookie/{{cookiecutter.project_slug}}/build-system/skcde…

cf53ab7

…mo.cpp Co-authored-by: Saransh Chopra <[email protected]>

Update tests/smoke/base.sh

263dcf9

Co-authored-by: Saransh Chopra <[email protected]>

Update tests/smoke/base.sh

93a1639

Co-authored-by: Saransh Chopra <[email protected]>

Rename scikit-pyproject.toml to scikit-build-core-pyproject.toml

6bcc4db

xmnlab requested changes Aug 1, 2023

View reviewed changes

src/scicookie/hooks/post_gen_project.py Outdated Show resolved Hide resolved

src/scicookie/{{cookiecutter.project_slug}}/conda/dev.yaml Outdated Show resolved Hide resolved

tests/smoke/base.sh Outdated Show resolved Hide resolved

ayeankit and others added 3 commits August 2, 2023 01:35

Update src/scicookie/{{cookiecutter.project_slug}}/conda/dev.yaml

dbd78bf

Co-authored-by: Ivan Ogasawara <[email protected]>

Update src/scicookie/hooks/post_gen_project.py

e94be9a

Co-authored-by: Ivan Ogasawara <[email protected]>

Update tests/smoke/base.sh

c2127d7

Co-authored-by: Ivan Ogasawara <[email protected]>

xmnlab approved these changes Aug 1, 2023

View reviewed changes

xmnlab merged commit 3dc8562 into osl-incubator:main Aug 1, 2023
11 checks passed

github-actions bot added the released label Aug 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat(template): Added scikit as an option for build system #161

Feat(template): Added scikit as an option for build system #161

ayeankit commented Jul 31, 2023

xmnlab commented Jul 31, 2023

xmnlab commented Jul 31, 2023

ayeankit commented Jul 31, 2023

xmnlab left a comment

xmnlab Jul 31, 2023

xmnlab Jul 31, 2023

xmnlab Jul 31, 2023

Saransh-cpp left a comment

ayeankit commented Jul 31, 2023 •

edited

Loading

Saransh-cpp commented Jul 31, 2023

ayeankit commented Aug 1, 2023

ayeankit commented Aug 1, 2023

Saransh-cpp commented Aug 1, 2023

Saransh-cpp left a comment

Saransh-cpp Aug 1, 2023

ayeankit Aug 1, 2023

xmnlab left a comment

github-actions bot commented Aug 9, 2023

Feat(template): Added scikit as an option for build system #161

Feat(template): Added scikit as an option for build system #161

Conversation

ayeankit commented Jul 31, 2023

Pull Request description

How to test these changes

Pull Request checklists

Additional information

Reviewer's checklist

xmnlab commented Jul 31, 2023

xmnlab commented Jul 31, 2023

ayeankit commented Jul 31, 2023

xmnlab left a comment

Choose a reason for hiding this comment

xmnlab Jul 31, 2023

Choose a reason for hiding this comment

xmnlab Jul 31, 2023

Choose a reason for hiding this comment

xmnlab Jul 31, 2023

Choose a reason for hiding this comment

Saransh-cpp left a comment

Choose a reason for hiding this comment

ayeankit commented Jul 31, 2023 • edited Loading

Saransh-cpp commented Jul 31, 2023

ayeankit commented Aug 1, 2023

ayeankit commented Aug 1, 2023

Saransh-cpp commented Aug 1, 2023

Saransh-cpp left a comment

Choose a reason for hiding this comment

Saransh-cpp Aug 1, 2023

Choose a reason for hiding this comment

ayeankit Aug 1, 2023

Choose a reason for hiding this comment

xmnlab left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 9, 2023

ayeankit commented Jul 31, 2023 •

edited

Loading