• README.md
• Requirements.txt
• Setup.py
• Test (directory)
• Src / projecct_name (directory)
• Scripts (directory)
• Docs (directory)
• .github (directory)
• .coveragerc

• When recalling relative functions/modules, always use such absolute import method: “import project_name.module_name …”

Write script files in ‘scripts’.

When recalling relative functions/modules, always use such absolute import method: “import project_name.module_name …”, but make sure to add this sentence at the first of the script:

  import sys
  sys.path.append("..")

This can make sure the script can find these modules. Otherwise, a ‘module not found’ error would occur.

Write test files in ‘tests’ Note, to avoid import Error, we need: 1. Test files should call absolute modules’ name directly. 2. Create a runner.py with the following contents:

  ```python
  test_dir = os.path.dirname(os.path.realpath(__file__))
  package_dir = os.path.dirname(test_dir)
  sys.path.append(package_dir)
  ```

Write a test runner to run all test files

When recalling relative functions/modules, always use such absolute import method: “import project_name.module_name …”,

There are two methods to run all test files: Command method:

  python -m unittest discover
  In python file:

or runner.py:

  loader = unittest.TestLoader()
  tests = loader.discover('.', pattern='test_*.py')
  testRunner = unittest.runner.TextTestRunner()
  test_results = testRunner.run(tests)

Similarly, there are two methods to run code coverage: Command method:coverage run -m unittest discover, or In runner.py file:

      if COV_FLAG:
          cov = coverage.coverage()
          cov.start()
    
      loader = unittest.TestLoader()
      tests = loader.discover('.', pattern='test_*.py')
      testRunner = unittest.runner.TextTestRunner()
      test_results = testRunner.run(tests)
    
      if COV_FLAG:
          cov.stop()
          cov.save()
          # 命令行模式展示结果
          cov.report()
          # 生成HTML覆盖率报告
          cov.html_report(directory='./tests/covhtml')
          cov.xml_report(outfile='./tests/cov_report.xml')

Here, we use the second method for unittest and coverage report.

Create a runner.py here with the following content:

  import unittest
  import coverage
  COV_FLAG = True
  if __name__ == "__main__":
      if COV_FLAG:
          cov = coverage.coverage()
          cov.start()
    
      loader = unittest.TestLoader()
      tests = loader.discover('.', pattern='test_*.py')
      testRunner = unittest.runner.TextTestRunner()
      test_results = testRunner.run(tests)
    
      if COV_FLAG:
          cov.stop()
          cov.save()
          # 命令行模式展示结果
          cov.report()
          # 生成HTML覆盖率报告
          cov.html_report(directory='./tests/covhtml')
          cov.xml_report(outfile='./tests/cov_report.xml')
    
      if test_results.wasSuccessful():  # used in github actions to make sure actions fail when tests fails
          exit(0)
      else:
          exit(1)

• goto https://app.codecov.io/gh/Jingnan-Jia
• login with your github account
• select repositories from ‘not yet setup’
• copy the token to the github’s project’s setting’s secret.
• add the following code to ‘.github/workflows/test_and_coverage.yml’ ```python
• name: “Upload coverage to Codecov” uses: codecov/codecov-action@v2 with: fail_ci_if_error: true # optional token: $ # not required for public repos ```
• In README.md, add the following badge code: ```python

``` You can the branch, otherwise, using the default branch. More details about getting badges: https://github.com/dwyl/repo-badges

• sphinx-quickstart docs
• sphinx-build -b html docs/source/ docs/build/html(equal to: make html) # optional
• Install this theme: pip install sphinx-rtd-theme
• Change config.py # very important !!!

    html_theme = 'sphinx_rtd_theme'
    sys.path.insert(0, os.path.abspath('../..'))
    sys.path.insert(0, os.path.abspath('../../project_name'))
  

• Try to make html at first: make html

• ‘sphinx-apidoc -o docs/source project_name –force’ locally to generate files in ‘source’ directory at first.
• edit the index.rst to combine all docs together.
• Then look the below steps:
• Create a file .readthedos.yml: ```python # .readthedocs.yml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required version: 2

# Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py

# Build documentation with MkDocs #mkdocs: # configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub # formats: all

# Optionally set the version of Python and requirements required to build your docs python: version: 3.7 install: - requirements: docs/requirements.txt # system_packages: true

build: image: stable

  - Then create another file `docs/requirements.txt`:
  ```python
  # Defining the exact version will make sure things don't break
  sphinx
  sphinx_rtd_theme
  readthedocs-sphinx-search
  coverage==5.5
  parameterized==0.8.1
  pandas==1.0.5
  numpy==1.21.1
  tqdm==4.61.2

Follow This tutorial is very easy.