33 prepare for software release

[rogerkuou]

• Fix: rename points dimension to space
• Tests
  • Tests for _io.py
• Documentation
  • add logo
  • mkdoc rendering
  • Function Examples
  • Add tutorial
• Add a pyproject.toml file
  • Update doc link
  • Update change log link
• GitHub actions
  • Build
  • Doc deploy when merge to main
  • Test
• Citations
  • cff
  • zenodo json
• README
  • Update description
  • Installation example
  • Checklist Badge:
  • Other badges:
    • Sonarcloud
• Update author names:
  • .cff
  • pyproject.toml
  • zenodo.json

[rogerkuou]

Hi @fnattino and @SarahAlidoost, thanks for the review! I made update accoding to your comments, below is a summary:

GH actions:

• Added build tests in build.yml
• Fixed dependency installation in build.yml. Now the package dependencies are not installed in build.yml. That is down in sonarcloud.yml
• Add Doc build test in build.yml
• I still did not run unit test in build.yml since I think it is already covered in sonacloud.yml
• Added pipy.yml. It will be triggered by a release. I will keep Finish software release #37 open for now.

Docs

• Added some mkdocs extensions and enabled the python syntax rendering
• Add a WIP claim in the "common operations" Tab. Submitted an issue for future work.
• Fixed type in CHANGELOG.md and updated links

Citation

• Updated the DOI in README to 10.5281/zenodo.7717027, it refers to all versions now.
• Updated zenodo name to .zenodo.json
• Applied Sarah's suggestion on her name >_-

Could you please have another look?

[fnattino]

Great @rogerkuou!

• I still did not run unit test in build.yml since I think it is already covered in sonacloud.yml

The only difference is that build runs for a set of OSs and Python versions, while sonar cloud can run for a single OS and version. So if you would like to find issues with different setups, you can run tests (without coverage) in build as well.

The only missing thing, in case you want to add it, is the contributing instructions. But for the rest, looks very good to me!

[rogerkuou]

. But for the rest, looks very good to me!

Ah thanks, I will apply both: 1) add a tests in build, and 2) add a contributing instruction

[rogerkuou]

Hi @fnattino, I added the tests to build.yml and also added Contribution doc (mainly adpated from the CGC package). Would you like to give another look?

[fnattino]

All looks good to me! :)

[SarahAlidoost]

@rogerkuou thanks for addressing the comments. I added some suggestions/comments and approved this PR.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

96.3% Coverage
0.0% Duplication