Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zillionare/python-project-wizard

A tool for creating skeleton python project, built with popular develop tools and conform to best practice.
https://github.com/zillionare/python-project-wizard

boilerplate boilerplate-template codecov cookiecutter cookiecutter-pypackage cookiecutter-template flake8 github-ci mkdocstrings poetry pre-commit-hooks python scaffold starter-kit startertemplate template tox

Last synced: 2 days ago
JSON representation

A tool for creating skeleton python project, built with popular develop tools and conform to best practice.

Host: GitHub
URL: https://github.com/zillionare/python-project-wizard
Owner: zillionare
License: bsd-3-clause
Created: 2021-04-10T14:46:32.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2023-09-09T10:29:08.000Z (over 1 year ago)
Last Synced: 2025-02-01T16:06:29.350Z (9 days ago)
Topics: boilerplate, boilerplate-template, codecov, cookiecutter, cookiecutter-pypackage, cookiecutter-template, flake8, github-ci, mkdocstrings, poetry, pre-commit-hooks, python, scaffold, starter-kit, startertemplate, template, tox
Language: Python
Homepage: https://zillionare.github.io/python-project-wizard/
Size: 1.03 MB
Stars: 130
Watchers: 3
Forks: 114
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # Python Project Wizard

A tool for creating skeleton python project, built with popular develop tools and

conform to the best practice.

[![Version](http://img.shields.io/pypi/v/ppw?color=brightgreen)](https://pypi.python.org/pypi/ppw)

[![CI Status](https://github.com/zillionare/python-project-wizard/actions/workflows/release.yml/badge.svg)](https://github.com/zillionare/python-project-wizard)

[![Dowloads](https://img.shields.io/pypi/dm/ppw)](https://pypi.org/project/ppw/)

[![License](https://img.shields.io/pypi/l/ppw)](https://opensource.org/licenses/BSD-2-Clause)

![Python Versions](https://img.shields.io/pypi/pyversions/ppw)

[![Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## Features

This tool will create Python project with the following features:

* [Poetry]: Manage version, dependancy, build and release

* [Mkdocs]: Writting your docs in markdown style

* Testing with [Pytest] (unittest is still supported out of the box)

* Code coverage report and endorsed by [Codecov]

* [Tox]: Test your code against environment matrix, lint and artifact check.

* Format with [Black] and [Isort]

* Lint code with [Flake8] and [Flake8-docstrings]

* [Pre-commit hooks]: Formatting/linting anytime when commit/run local tox/CI

* [Mkdocstrings]: Auto API doc generation and docstring template (vscode and its extension [autodocStrings] is required)

* Command line interface using [Python Fire] (optional)

* Continuouse Integration/Deployment by [github actions], includes:

    - publish dev build/official release to TestPyPI/PyPI automatically when CI success

    - publish documents automatically when CI success

    - extract change log from github and integrate with release notes automatically

* Host your documentation from [Git Pages] with zero-config

* Support multiple versions of documentations (by [mike])

* Create repo and push initial commits by repo.sh script

## Quickstart

Install ppw if you haven't install it yet:

```

  pip install -U ppw

```

Generate a Python package project by simple run:

```

  ppw

```

Then follow the **[Tutorial]** to finish configurations.

# Credits

This repo is forked from [audreyr/cookiecutter-pypackage], and borrowed some ideas from [briggySmalls]

[poetry]: https://python-poetry.org/

[mkdocs]: https://www.mkdocs.org

[pytest]: https://pytest.org

[codecov]: https://codecov.io

[tox]: https://tox.readthedocs.io

[black]: https://github.com/psf/black

[isort]: https://github.com/PyCQA/isort

[flake8]: https://flake8.pycqa.org

[flake8-docstrings]: https://pypi.org/project/flake8-docstrings/

[mkdocstrings]: https://mkdocstrings.github.io/

[Python Fire]: https://github.com/google/python-fire

[github actions]: https://github.com/features/actions

[Git Pages]: https://pages.github.com

[Pre-commit hooks]: https://pre-commit.com/

[mike]: https://github.com/jimporter/mike

[autoDocStrings]: https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring

[Tutorial]: https://zillionare.github.io/python-project-wizard/tutorial/

[audreyr/cookiecutter-pypackage]: https://github.com/audreyr/cookiecutter-pypackage

[briggySmalls]: https://github.com/briggySmalls/cookiecutter-pypackage

# Links

## cfg4py

[cfg4py](https://pypi.org/project/cfg4py/) is a great tool for managing configuration files, supporting configuration for different environments (dev, prodction and test), automatically converting yaml-based configuration to python class, so, you can access configuration items by attribute, thus, enable auto-completion (by IDE). It also supports live-reload, remoting central configuration, config template and more.