osl-incubator / scicookie

Cookiecutter template for a Python package.
https://osl-incubator.github.io/scicookie
Other
11 stars 18 forks source link

Some requests as a user #184

Closed EverVino closed 6 months ago

EverVino commented 1 year ago

Summary

I created a project with cookie cutter. I found that

Additional Information

No response

Code of Conduct

xmnlab commented 1 year ago

Documentation here is not updated I'm assuming that is the official docs because is in the repo gh page

thanks for caching that!

When I created the project the main branch has different name like add-initial-structu.. is not standard

yes, that is because it couldn't change the main directly for a bunch of reason ... and you should open a PR to main from there. if you don't have a main branch in your remote that branch would be defined as default, that is not good ... maybe we could check first if there is a main branch on remote, otherwise, it could create the branch as main

I'd like to have an easy start, It will be great to have an yaml file to start with conda or a pyproject.toml to install an initial virtual env

could you give more details about that?

I'd like to have an option use another docs generator. I want to use another static site generator like hugo for docs

I think that hugo is not in the plan for now, we have already options for sphinx, mkdocs and jupyter-book, and we are planning to add support for quarto. but if you want to contribute with hugo support, it would be very welcome :)

EverVino commented 1 year ago

I'd like to have an easy start, It will be great to have an yaml file to start with conda or a pyproject.toml to install an initial virtual env

In the first push to the remote repository the CI failed, I have no idea why, I will check, but that time I will only add a file with comments in the code.

I think that hugo is not in the plan for now, we have already options for sphinx, mkdocs and jupyter-book, and we are planning to add support for quarto. but if you want to contribute with hugo support, it would be very welcome :)

Ok, I'm starting to think how to add hugo.

xmnlab commented 1 year ago

about the error, if the repo you are trying to use is mass-transfer-py https://github.com/osl-pocs/mass-transfer-py/actions/runs/6240174858/job/16939678221#step:3:172

it seems that it doesn't have the conda/dev.yaml and this is trying to use it

I don't remember if you have conda as an option now ...

xmnlab commented 6 months ago

@EverVino , I think we can already close this issue. feel free to open a new one if you find more things to be fixed or be implemented. thanks