unity-sds / unity-py

Apache License 2.0
2 stars 3 forks source link

Merge `develop` to `main` to address package naming. #52

Closed anilnatha closed 1 year ago

anilnatha commented 1 year ago

This PR addresses the need to update the package name so users can reference the name unity_sds_client when importing the package and not unity_py. This way the imports match the name used when installing from PyPi and to get this change into the main branch so that we may publish it to PyPi.

rtapella commented 1 year ago

Once we finish these updates... how does it get pushed into Pypi? Manually? Is the process linked/documented here?

Also how do we document this? Can we just run some auto-doc thing?

mike-gangl commented 1 year ago

@rtapella publishing to pypi is done when a "release" is created from the main branch. we should document that process.

anilnatha commented 1 year ago

Once we finish these updates... how does it get pushed into Pypi? Manually? Is the process linked/documented here?

Also how do we document this? Can we just run some auto-doc thing?

@rtapella Early on I tinkered with pdoc, wonder if we can use a github action to generate the docs and publish them to Github pages