Skip to content
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

Task list for cookie-cutter #4

Closed
23 of 24 tasks
Sparks29032 opened this issue Jun 18, 2024 · 3 comments
Closed
23 of 24 tasks

Task list for cookie-cutter #4

Sparks29032 opened this issue Jun 18, 2024 · 3 comments

Comments

@Sparks29032
Copy link
Collaborator

Sparks29032 commented Jun 18, 2024

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:

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

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

  • main.yml
  • docs.yml

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

  • Makefile
  • source/conf.py
  • source/index.rst
  • source/license.rst

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

  • diffpy/init.py
  • diffpy/<package_name>/init.py
  • diffpy/<package_name>/version.py

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

  • init.py
  • run.py
  • debug.py
  • conftest.py

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

  • setup.py (see PR in diffpy.srreal)
  • src/extensions (directory to house our extensions)
@Tieqiong
Copy link
Contributor

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

@Sparks29032
Copy link
Collaborator Author

Added

@sbillinge
Copy link
Collaborator

closed as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants