CDL-tutorials icon indicating copy to clipboard operation
CDL-tutorials copied to clipboard

add script to generate all non-code files automatically if they don't exist

Open jeremymanning opened this issue 7 years ago • 1 comments

  • 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

jeremymanning avatar Aug 22 '18 15:08 jeremymanning

bonus points:

  • output an admonishment if user is using python 2
  • construct sample tweet

jeremymanning avatar Aug 22 '18 15:08 jeremymanning