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

[FEATURE:] Add opinionated creation #54

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Conversation

ByteOtter
Copy link
Owner

@ByteOtter ByteOtter commented Aug 1, 2023

What does this PR change?

This PR, once finished will give the user the option to let Nester create a project with a set of configurations already done.

It will automatically install and provide basic configuration files for a selected set of linters and build files such as pyproject.tomland will populate these files accordingly.

For now the tools selected are the following:

  • Python:
    • Build tools: setuptools, setuptools-scm and wheel
    • Linters: black, pylint and isort
    • Note on Poetry: Poetry will not be supported by Nester for now as we assess that people who would like to use it, will use it to set up their entire project. Therefore we do not see a need for it.

Other tools TBA.

TODO:

  • Construct list of supported tools
  • Implement logic to write configuration files (--> BUG: Dump logic does not work!)
  • Implement logic to automatically install the required tools
  • Link creation logic to CLI frontend (-o flag)
  • Link creation logic to TUI frontend

Tick the applicable box:

  • Add new feature
  • Add language support
  • UI improvement
  • Security changes
  • Tests
  • Documentation changed

  • General Maintenance

UI changes

  • CLI: Added -o or --opinionated flags to CLI

  • TUI: TBA

  • DONE

Links

Fixes: #29

  • DONE

Documentation

  • No documentation needed

  • DONE

@ByteOtter ByteOtter force-pushed the opinionated-creation branch from 29e8025 to 79e3be8 Compare August 1, 2023 20:52
@github-actions github-actions bot added the cli-frontend Related to Nester's CLI behavior label Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli-frontend Related to Nester's CLI behavior packaging python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[PROPOSAL/TASK:] Opinionated creation of project tree
1 participant