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

Strip project template #2756

Closed
4 tasks
amandakys opened this issue Jul 3, 2023 · 1 comment
Closed
4 tasks

Strip project template #2756

amandakys opened this issue Jul 3, 2023 · 1 comment
Labels
Issue: Feature Request New feature or improvement to existing feature

Comments

@amandakys
Copy link

amandakys commented Jul 3, 2023

Description

We want to simplify the project template in preparation for future work based on #2388 to allow the linting, testing, docs, and the other removed features to be optionally inserted.

The simplified project template

└── project-dir          
	├── .gitignore 
	├── conf
		└── base
			├── catalog.yml          #blank files
			└── parameters.yml       #blank files
		└── local
			└── credentials.yml     
	├── notebooks       
	├── pyproject.toml  
	├── README.md              
	└── src 
		├── requirements.txt
		├── setup.py   
		└── project-code 
			├── pipeline_registry.py
			├── settings.py                  
			└── pipelines
				

Files & Directories to be removed
/tests
/docs
/data
/logs
setup.cfg
conf/base/logging.yml

Files to. be updated
requirements.txt should be updated to remove all unnecessary dependencies

https://github.com/amandakys/kedro-plugin-validation - i made this repo to demo what the base project template would look like - msg me if you'd like access.

Possible Alternatives

in #2149 we also discuss the removal of requirements.txt and setup.py and merging them into pyproject.toml. This should not block this ticket and should be discussed as a follow up see #2757

Implementation

This change needs to be reflected in

  • framework
  • framework blank template
  • starters
  • docs
@merelcht
Copy link
Member

We discussed this ticket in grooming and decided that with the new project creation flow, where we'll be stripping the template with the post project hook, a stripped project template isn't necessary anymore.

@merelcht merelcht closed this as not planned Won't fix, can't repro, duplicate, stale Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue: Feature Request New feature or improvement to existing feature
Projects
Archived in project
Development

No branches or pull requests

2 participants