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

[IDEA] Software Development Tools and Python version #74

Open
gialmisi opened this issue Dec 4, 2023 · 1 comment
Open

[IDEA] Software Development Tools and Python version #74

gialmisi opened this issue Dec 4, 2023 · 1 comment
Labels
restructuring Label for the DESDEO restructuring project

Comments

@gialmisi
Copy link
Contributor

gialmisi commented Dec 4, 2023

  • What is the current behavior?
    We have currently made some choices regarding the software development tools utilized across the packages found in DESDEO. Some of these choices might require updating to a tool better suited given our needs.

  • Describe the solution you'd like
    Based on our earlier discussion, we have the following tools on the table:

    • Package and project manager: poetry (same as before)
    • Documentation: MkDocs (was Sphinx previously, see [IDEA] Documentation tool and style #72 )
    • Formatter: black, but move to ruff once it is stable (previously black)
    • Linter: ruff (was pylint? previously)
    • Testing: pytest (same as before)
    • Python version: 3.12 and update as soon as possible
  • What is the motivation/use case for changing the behavior?
    Since we are rethinking the structure of the project (see [IDEA] New project structure for DESDEO #73 ), it is a good time to rethink the software development tools we intend to use so that we may choose the tools that best suit our needs.

  • Describe alternatives you've considered
    Especially to linters and formatters, there are many alternatives. ruff seems a good candidate because it is very fast and therefore does not slow down the development process due to, e.g., excess processing times. The discussion about moving to MkDocs from Sphinx is found in another issue ([IDEA] Documentation tool and style #72 ). There really are not better alternatives to poetry right now, and for testing, which will consist mostly of unit tests, pytest is an industry standard. With the Python version, we should update it as frequently as possible.

  • Additional context

@gialmisi gialmisi added the restructuring Label for the DESDEO restructuring project label Dec 4, 2023
@light-weaver
Copy link
Member

Ruff formatting is already stable apparently. Numba will release a py3.12 version soon as well.

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

No branches or pull requests

2 participants