Task list for cookie-cutter

Sparks29032 commented 2 weeks ago

To claim a task, create a new issue addressing one of the following files. These files should be based off of diffpy.utils. We will check off each task only upon PR merges. Add on anything you think I am missing.

root
|--.github
|  |--workflows
|     |  main.yaml
|     |  docs.yaml
|--requirements
|  |  build.txt
|  |  run.txt
|  |  docs.txt
|  |  test.txt
|  |  pip.txt
|--doc
|  |  Makefile
|  |--source
|     |  conf.py
|     |  index.rst
|     |  license.rst
|  .gitignore
|  README.rst
|  LICENSE.rst
|  .pre-commit.yaml
|  .flake8
|  .isort.cfg
|  .codecov.yml
|  pyproject.toml
|  setup.py (for C++/C extensions)
|--src
   |--extensions (for C++/C extensions)
   |--diffpy
      |  __init__.py
      |--<package_name>
         |  __init__.py
         |  version.py
         |--tests
            |  run.py
            |  debug.py
            |  conftest.py

The cookie-cutter needs to build the following files in root:

[x] pyproject.toml
[x] .gitignore
[x] .pre-commit-config.yaml
[x] .flake8
[x] .isort.cfg
[ ] README.rst
[x] CHANGELOG.rst
[x] LICENSE.txt (do we want to change to .rst?)
[x] .codecov.yml

We should include the following github workflows in the .github/workflows directory:

[x] main.yml
[x] docs.yml

There should be a directory for building documentation doc with the following files:

[x] Makefile
[x] source/conf.py
[x] source/index.rst
[x] source/license.rst

The directory structure of the package proper should be housed in a src directory with the following files:

[x] diffpy/init.py
[x] diffpy//init.py
[x] diffpy//version.py

We should also have a test suite set up at src/diffpy/<package_name>/tests with the following files:

[x] init.py
[x] run.py
[x] debug.py
[x] conftest.py

For our diffpy c++ extensions, we need the following files and directories:

[x] setup.py (see PR in diffpy.srreal)
[x] src/extensions (directory to house our extensions)

Tieqiong commented 2 weeks ago

@Sparks29032 Can we add a index.rst in /doc/source? see #58

Sparks29032 commented 2 weeks ago

Added

Billingegroup / cookiecutter

Task list for cookie-cutter #4