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

Turn into a cookiecutter template #2

Merged
merged 54 commits into from
Mar 3, 2022
Merged

Turn into a cookiecutter template #2

merged 54 commits into from
Mar 3, 2022

Conversation

jorgepiloto
Copy link
Member

@jorgepiloto jorgepiloto commented Feb 21, 2022

This PR solves for #1. Several tasks need to be completed before this can be merged:


PR Follow-up

@jorgepiloto
Copy link
Member Author

At first, I was considering using cookiecutter private variables in order to sanitize inputs from the user. Although private variables are available in cookiecutter==1.7.3, they do not render properly, see issue cookiecutter/cookiecutter#1461. Furthermore, latest releases of cookiecutter have been published only in PyPI test, forcing users to run:

python -m pip install python -m pip install https://github.com/cookiecutter/cookiecutter/archive/refs/tags/2.0.2.tar.gz

By the way, previous installation ships with wrong metadata, saying that installed version is 2.0.0 instead of 2.0.2... Having encountered all these issues, I decided to use cookiecutter==1.7.3 an wait till issue cookiecutter/cookiecutter#1636 is solved.

@jorgepiloto
Copy link
Member Author

Preparing tox, GitHub actions and tests to speed up this using TDD.

@jorgepiloto jorgepiloto force-pushed the feat/template branch 2 times, most recently from 3f46c90 to da9690c Compare February 21, 2022 11:23
@jorgepiloto
Copy link
Member Author

jorgepiloto commented Feb 21, 2022

Although the actions are setup, I see that the style checks are being running in implicit form inside the py37 jobs. Let me try to make those explicit so that the resulting actions look like:

- Code style
- Baking tests [all matrix.os and matrix.python-version]

@jorgepiloto jorgepiloto force-pushed the feat/template branch 4 times, most recently from ddfcc15 to 5d953b3 Compare February 21, 2022 12:02
@jorgepiloto
Copy link
Member Author

Cool, now code style is a separate job in the CI pipelines and is not executed twice in py37 testing environments.

@jorgepiloto
Copy link
Member Author

Following the culture from other projects in the organization, let me also include the pre-commit tool 👍

@jorgepiloto
Copy link
Member Author

jorgepiloto commented Feb 21, 2022

While trying to add a check for the poetry install baked_project --with group0,group1,... I ran into the following issue python-poetry/poetry#4842. It is not a big deal anyway, but hose repeated optional = true flags are a little bit annoying.

@jorgepiloto jorgepiloto force-pushed the feat/template branch 16 times, most recently from 4e98746 to 33a1cc9 Compare February 21, 2022 17:51
@jorgepiloto
Copy link
Member Author

jorgepiloto commented Mar 2, 2022

Just before merging:

  • Documenting how to use this template in README.md.
  • Document baked project README.md according to build-system.
  • Check dependabot.

@jorgepiloto jorgepiloto force-pushed the feat/template branch 5 times, most recently from c6227fa to 69b24d7 Compare March 2, 2022 17:20
@jorgepiloto
Copy link
Member Author

Finally, this is ready for review, @akaszynski.

We covered all the currently available building systems and tested those in deep (when possible). During the next days, we should expect feedback in the form of issues, enhancements or even bugs.

@jorgepiloto jorgepiloto marked this pull request as ready for review March 2, 2022 18:22
@jorgepiloto jorgepiloto merged commit 3b64789 into main Mar 3, 2022
@jorgepiloto
Copy link
Member Author

Merging this! I did not squashed commits so we can properly point to outdated failing actions in order to report issues to third party libraries.

@akaszynski akaszynski deleted the feat/template branch March 3, 2022 07:53
ansRMorin added a commit that referenced this pull request May 26, 2023
ansRMorin added a commit that referenced this pull request May 30, 2023
* add scenery and node status view components

* update dependencies

* update import

* fix linting issue?

* fix style errors

* fix another style error

* attempt #2

* update pyproject.toml + Readme + License + tox (#264)

* update pyproject.toml + Readme + License + tox

* fix issue

* fix issue

* update the pyproject.toml

* fix code style issue

* add optislang-dash-lib package

---------

Co-authored-by: Jerfried Boly <115999670+ansJBoly@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants