software release

[rogerkuou]

• Tests
  • already there
  • lint test
• Documentation ---> @rogerkuou
  • add logo
  • mkdoc rendering
  • Function Examples
  • Add tutorial
  • Add contributing or developerguide
• GitHub actions ---> @SarahAlidoost
  • Add a pyproject.toml file
    - Update doc link
    - Update change log link
    - Update author names
  • Build package and documentation when push and pull request
  • Doc deploy when release
  • Test using sonarcloud!
    - set up sonar (one-time)
    - setup sonar and github secrets token
    - add sonar properties file
• Update citations and author names
  • cff
  • zenodo json
• README ---> @SarahAlidoost
  • Update description
  • Installation example
  • Checklist Badge:
  • Other badges:
    • Sonarcloud
• Publish to PyPI
  • GH workflow

[fnattino]

See TUDelftGeodesy/sarxarray#33

[SarahAlidoost]

@rogerkuou it is possible to use styling tools like ruff in a github action workflow to run linter. The configurations can be set in pyproject.toml. Here one example of pyproject.toml and github workflow.

[rogerkuou]

Good idea! I will try it in #51