Comments (2)
Those folders and scripts in src/
right now are just some examples and stubs, more for inspiration than to set a standard structure. It seems like this folder is going to be so different depending on project-specific goals, people are going to have to choose what they need based on each project — from the simple (a couple scripts directly in src/
) to the complex (multiple languages/apps/subfolders).
That being said, I really like how you've organized that for multiple languages. Two thoughts:
- @pjbull and I have been talking about how we can feature examples of the cookiecutter data science template being used in different ways, so if you have an open-sourceable project we'd love to point to it.
- Maybe we could add "cookbook"/"common patterns"/"example" section or page to the documentation highlighting ideas like this? It would be a great middle ground between changing the base structure for everyone and letting these good ideas fall through the cracks.
from cookiecutter-data-science.
Ahh thats great.
I am basically merging my own (nascent) cookiecutter for snakemake-based analysis pipelines into my fork of this project and I was worried about bumping up against this (http://drivendata.github.io/cookiecutter-data-science/#be-conservative-in-changing-the-default-folder-structure). But now that I think about it some more, I suppose that what you mean by "changing the folder structure for all projects" would concern things like pull requests to the upstream repo.
Regarding pointing to my project: That would be great. As soon as I work out the kinks that will surely result from merging my old system into this general framework, I will shoot you guys a line.
How to feature examples: I think adding a section in the readme.md
would allow folks to add their "interesting use-case" and submit a PR. That way you guys don't have to go out LOOKING for them but still have final say over what gets added. I think that is how the crew over at https://github.com/audreyr/cookiecutter do it, anyway.
from cookiecutter-data-science.
Related Issues (20)
- Make v1 template docs accessible in new docs
- Termynal markdown page should not be included HOT 1
- v2 release logistics checklist HOT 1
- ideas for documentation about just+pyproject.toml+mkdocs HOT 1
- Defend against broken paths from non-editable installs
- Document how to use the Python source code scaffolding
- Document conda-forge as a way to install make
- Option for Poetry support for package managent
- Update directory structure in README to reflect v2
- Add tag for v2 HOT 1
- Release package on conda-forge HOT 1
- Add badges to README
- config import fails when using V2 scaffolding HOT 2
- Consolidate linting and formatting to use ruff
- Add documentation about contributing and requesting tools
- Is there an example project? HOT 1
- Ruff lint configuration names are incorrect HOT 1
- Release tagging mechanics HOT 3
- Proposal to add a test folder on the v2.0.0 template
- Wrong path for the "make data" command in Makefile
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cookiecutter-data-science.