add script to generate all non-code files automatically if they don't exist
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- jupyter-notebook, python
- Domain
- build-system, documentation, testing, tooling
Research direction
Start by reviewing the requested generated files: setup.py, conf.py, MANIFEST.in, README.md, requirements.txt, license.txt, api.rst, index.rst, tutorials.rst, and the example notebook. Define how the script should detect missing files and how setup.py values affect them. Done means missing package, test, example, and documentation files are generated and the requested GitHub, Travis, Read the Docs, release, fork, and pip steps are output as a to-do list.
Written by the indexing model from the issue text.
Description
- setup.py (use folder name as name of project, and if any of the below are specified, change the script accordingly to reference them)
other info could be read from setup.py
- conf.py
- MANIFEST.in
- README.md
- requirements.txt
- license.txt
- basic test (so pytest can run)
- basic example (so sphinx compiles)
- api.rst
- index.rst
- tutorials.rst
- sample tutorial notebook
then output a "to do" list of how to:
- set up github web hooks for slack
- get travis configured
- compile sphinx web page
- register on readthedocs and publish readthedocs page
- do a github release
- set up forks on github for development (once package is "live," rather than modifying master branch directly)
- push to pip (after package is ready for release)
- install package from pip
- Dominant language
- Jupyter Notebook
- Stars
- 17
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ContextLab/CDL-tutorials
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
ContextLab/CDL-tutorials#68 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 45/100
ContextLab/CDL-tutorials#69 ·
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
ContextLab/CDL-tutorials#67 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
ContextLab/CDL-tutorials#64 ·
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
ContextLab/CDL-tutorials#62 ·
All issues in ContextLab/CDL-tutorials
Similar issues
-
Update to NCCL 2.32 Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
conda-forge/nccl-feedstock#166 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
dsx-ai-factory/infra-controller#6694 ·
-
bug build
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
facebookincubator/velox#19143 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
pydantic/pydantic-ai#8636 ·
-
0.kind: enhancement 9.needs: package (update)
Difficulty 2/5 1-3 hours Newbie friendliness 74/100