8000 Add link to python-module-cookiecutter by gsemet · Pull Request #1066 · cookiecutter/cookiecutter · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add link to python-module-cookiecutter #1066

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

Closed
wants to merge 1 commit into from

Conversation

gsemet
Copy link
@gsemet gsemet commented Apr 16, 2018

Hi,

This is the cookiecutter I use everytime I need to create a python module. I started using pipenv a months ago, and combined with PBR and a proper tooling (doing here around a Makefile), it applies very well to library and application use cases. It is generic, that is does not bootstrap the code, only the tooling and build system.

PBR and pipenv handles pretty much all key things:

  • dependencies declaration
  • requirements.txt generation (for library) to support services such as readthedocs that does not support properly Pipfile yet
  • library tracks only Pipfile, PBR handle the injection into setup.py properly
  • application tracks both Pipfile and Pipfile.lock to maximize reproductibility
  • PBR allows semantic commit ("sem-ver: feature" in the commit message means a jump of minor versioning, "sem-ver: api-break" means a jump of major version)
  • of course "make tag-pbr" can automatically create the right tag according to the latest semantic commit.
  • travis.yml secret automatically retrieved from travis
  • travis pushes to pypi on successful tag build
  • yapf/isort formatting (enforcing 1 import per line to simplify merges)
  • test with pytest of course
  • fancy classic stuff: coverage report, editorconfig, dockerfile, ...

To see its usages:

planned: backport the automatic release note generation using OpenStack's reno project.

Signed-off-by: Gaetan Semet <gaetan@xeberon.net>
@codecov-io
Copy link
codecov-io commented Apr 16, 2018

Codecov Report

Merging #1066 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master   #1066   +/-   ##
======================================
  Coverage     100%    100%           
======================================
  Files          18      18           
  Lines         781     781           
======================================
  Hits          781     781

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0730981...893d0d4. Read the comment docs.

Copy link
Member
@insspb insspb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Local tox test with merged #1181:

___________________________________________________________________________________________________________ summary ___________________________________________________________________________________________________________
  py27: commands succeeded
  py35: commands succeeded
  py36: commands succeeded
  py37: commands succeeded
ERROR:   pypy: InterpreterNotFound: pypy
  flake8: commands succeeded

Merge required to start #1179

@insspb insspb added the needs-review PR Only: This PR require review from other developer label Jul 2, 2019
@ssbarnea
Copy link
Member

We are no longer maintaining a list of templates inside README file and instead we use github topics feature. Please read https://github.com/cookiecutter/cookiecutter#a-pantry-full-of-cookiecutters and add the needed topics to your repository and people will be able to find your template. The most important one is cookiecutter-template.

We are also going to remove most of already listed templates from there, in order not avoid being biased.

@ssbarnea ssbarnea closed this Jul 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-review PR Only: This PR require review from other developer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants
0