-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Added setup.py to project organization in README #236
Conversation
Looking good, some nice to haves....:
Cheers, |
Hi there! This PR is just a typo fix, so that README.md is coherent with {{ cookiecutter.repo_name }}/README.md, as well as with the directory structure of the template. The second suggestion is out of the scope of this PR and an issue should probably be opened to discuss it. |
@qalgit, for point 2, I'd say no. Use the "notebooks" directory for any kind of notebook. So if your project uses Jupyter notebooks, then put the ipynb files there. If your project uses R Markdown notebooks, then put the Rmd files there. If your project uses jupytext, then put the scripts there. Doesn't matter. The only change I'd consider making in this regard is to remove the "Juypter" part of the description. But it's up to each project to customise the repo for their purposes after it's been generated anyway. In my projects, I always rename the directory to "analysis" so that the scope is clearer, and change the convention to remove the author's initials. |
Thanks @bernardoamaral1011! On the consistency point, we'd welcome an issue where we can draft consistent language. On the notebooks folder, we won't add another level for different languages, that is way too uncommon a use case. |
commit 52283f7 Author: Peter Bull <pjbull@gmail.com> Date: Fri Mar 11 10:27:47 2022 -0800 Revert "Flag -c v1 is slightly confusing in branch v2 (drivendataorg#264)" This reverts commit d82776e. commit d82776e Author: Shubhankar <ghltshubh@users.noreply.github.com> Date: Fri Mar 11 12:25:13 2022 -0600 Flag -c v1 is slightly confusing in branch v2 (drivendataorg#264) commit 319222f Author: Jon Daniels <62617721+jdanielsbamboo@users.noreply.github.com> Date: Tue Jun 22 18:23:22 2021 -0600 Update index.md (drivendataorg#249) changing from "be" to "by" commit c077603 Author: Peter Bull <pjbull@gmail.com> Date: Fri Mar 19 22:33:34 2021 -0700 V1 tag and deprecation (drivendataorg#240) * deprecation warning * Update message and CLI call * Add to readme as well commit 3978e7d Author: Arturo Moncada-Torres <37126116+arturomoncadatorres@users.noreply.github.com> Date: Sat Mar 6 19:11:46 2021 +0100 Update documentation (drivendataorg#243) Add explicit definition of DAG (as requested in issue drivendataorg#69) commit 9bac80a Author: Bernardo Amaral <bernardoamaral1011@gmail.com> Date: Thu Jan 21 23:12:54 2021 +0000 Added setup.py to README's project organization (drivendataorg#236) Co-authored-by: bnamaral <bernardo.n.amaral@nos.pt> commit 0113a4a Author: Peter Bull <pjbull@gmail.com> Date: Tue Dec 22 10:46:23 2020 -0800 Update example commit fcc59e3 Author: Peter Bull <pjbull@gmail.com> Date: Thu Dec 10 09:12:53 2020 -0800 3.5 + commit 5f54d39 Author: Omri Mendels <omri374@users.noreply.github.com> Date: Tue May 26 20:16:03 2020 +0300 Fixed failing tests on Windows (drivendataorg#216) * Fixed failing tests on Windows Due to an issue with WindowsPath * Update test_creation.py * Update test_creation.py commit 78e001f Author: Natrave Drova <52951773+natravedrova@users.noreply.github.com> Date: Thu Apr 23 08:14:31 2020 +0300 Tox reference (drivendataorg#211) * Use a better link to the tox project * Use a better link to the tox project * Use a better link to the tox project commit 26c62b4 Author: Fokko Driesprong <fokko@driesprong.frl> Date: Mon Apr 6 18:05:54 2020 +0200 Typo (drivendataorg#208) commit 1fbe58b Author: Christopher Geis <16896724+geisch@users.noreply.github.com> Date: Mon Sep 23 17:49:26 2019 +0200 Fixed: Typo in Makefile (drivendataorg#184) Fixed typo in Makefile, section "Set up python interpreter environment": intalled --> installed commit ccbe207 Author: Wes Roach <wesr000@gmail.com> Date: Wed Sep 4 12:29:26 2019 -0500 Fix broken Airflow link (drivendataorg#182) commit 7dcc59d Author: Jonathan Raviotta <jraviotta@users.noreply.github.com> Date: Fri May 24 12:58:50 2019 -0400 Added source and destination to Make data target (drivendataorg#169) commit 997a9db Author: Eric Jalbert <ericmjalbert@users.noreply.github.com> Date: Mon May 6 12:41:28 2019 -0400 Change archived asciinema example (drivendataorg#163) * Change archived asciinema example * Update README.md Fix Asciinema powerline error * Update docs to show updated asciinema example
Small fix to the top level README since it was not coherent with the rest of the project and documentation.