search

audreyfeldroy / cookiecutter-pypackage

Cookiecutter template for a Python package.
BSD 3-Clause "New" or "Revised" License
4.24k stars 1.78k forks source link

Support for GitHub Actions and Pages #610

Open pablojimpas opened 3 years ago

pablojimpas commented 3 years ago

Description

It would be good if you can choose between GitHub Actions and Travis CI, I find it easier and faster since you don't have to create an account nor connect the repo.

A similar alternative could be offered for ReadTheDocs with GitHub Pages.

Zethson commented 3 years ago

@pablojimpas you might be interested in https://github.com/cookiejar/cookietemple/

The cli-python templates has Github Actions and BOTH, a ReadTheDocs setup and Github Pages. Think this is exactly what you are looking for :)

pablojimpas commented 3 years ago

Thanks @Zethson

zillionare commented 3 years ago

for those who want poetry, github actions, gitpages and markdown documentation, take a look at:

https://github.com/zillionare/cookiecutter-pypackage/

Features:

    Poetry: Manage version, dependancy, build and release
    Mkdocs: Writting your docs in markdown style
    Testing with unittest or Pytest
    Code coverage report and upload to Codecov
    Tox: Test your code against defined Python version matrix, lint and build artifact check.
    Format with Black and Isort
    Lint code with Flake8 and Flake8-docstrings
    Formatting/linting anytime when commit/run local tox/CI
    Mkdocstrings: Auto API doc generation
    Command line interface using Python Fire (optional)
    CI by github actions, auto publish from release branch when tests passed
    Host your documentation from Git Pages with zero-config