Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create fsspec cookiecutter template #6

Open
efiop opened this issue Jan 19, 2022 · 5 comments
Open

create fsspec cookiecutter template #6

efiop opened this issue Jan 19, 2022 · 5 comments

Comments

@efiop
Copy link
Member

efiop commented Jan 19, 2022

We have lots of inconsistencies across fsspec projects (ci, styling, linters, supported python versions, etc), which make it a pain to work with multiple projects at the same time.

We should create one recommended project template, put all recommended stuff into it and use cruft to keep the created projects up-to-date automatically. E.g. the template will contain a skeleton for new fs implementation, so automatic PRs would be a reminder to create new methods, as well as will try to add or remote particular python version support (though that could be handled by just creating an ABC for *FileSystem).

We use a similar approach in dvc plugins: https://github.com/iterative/cookiecutter-dvc-plugin

@martindurant
Copy link
Member

Certainly sounds like a nice addition. Would you need a separate sync and async version?

@efiop
Copy link
Member Author

efiop commented Jan 20, 2022

@martindurant It could be a conditional in the same template. Cookiecutter will ask you if you want sync or async version.

@martindurant
Copy link
Member

perfect!

@efiop
Copy link
Member Author

efiop commented Nov 28, 2022

After coming back to this over some time, I'm wondering if we should copy and adapt https://github.com/iterative/py-template Obviously I'm biased, but we've been searching for a good template and after not being satisfied by any particular one, @skshetry did a great job adapting https://github.com/cjolowicz/cookiecutter-hypermodern-python (threw out poetry as it is having problems when applied to libraries and seems to be a little polarising and a few other things). Any thoughts?

Created an empty https://github.com/fsspec/cookiecutter-fsspec to be able to create PRs in it.

@martindurant
Copy link
Member

I think it's a great idea, and having one framework doesn't preclude anyone else making other ones if they feel like it. Of course it's most useful if we have a tutorial of how it is used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants