Mgancita / cookiecutter-pypackage

Cookiecutter to create a Python package. Powered by Poetry, GitHub actions, and MkDocs-Material.

Home Page:https://mgancita.github.io/cookiecutter-pypackage/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Missing informations

MaKaNu opened this issue · comments

I tried first the originial pypackage template for cookiecutters and was disapointed about the usage with travis ci. So I searched for a template with github actions instead and found yours. I think I like most of the added Features but need to inform about a few of them. Specific poetry and the usage is something I need to learn if I want to use this template. It would be nice to have a updated version of the README to have a better understanding or at least a good starting point to reproduce the intendance of the template.

Hi!

I'm glad you decided to try the cookiecutter! Have you looked at the "Getting Started" section of the docs? This will give you the walkthrough of setting up the cookiecutter. As for more info on Poetry I'd visit their official docs as they do a great job so I wouldn't be able to explain it any better.

@MaKaNu have you been able to look through the links and see if they're sufficient? I'll close out this issue in a few days with no answer

Sorry for late response. Sadly I am very busy at the moment and I was not able to look inside. But I did a short look inside. What I was seeing on the first glance was the thing I actually was looking for. So the missing Information in the Readme is a link to this documentation. So I thought Contributing it is ;)

Oh didn't even realize that was missing on the readme! Just merged in your PR. Thanks for the first external pull request!

It was a plessure!