Release v0.1.4 (What’s new?).
Welcome to pywf_open_source Documentation¶
pywf_open_source streamlines open source Python project development by providing a unified workflow automation framework. It eliminates the cognitive overhead of switching between projects by normalizing common development tasks through a consistent interface.
The library automates common operations for projects using:
A public GitHub repo to host your project.
Use poetry to manage your project dependencies and build distribution package.
Use pytest unit test framework for testing.
Use GitHub Actions to run your test.
Use Codecov.io to publish your test coverage result.
Use sphinx-doc to build your documentation website.
A public ReadTheDocs project to host your documentation website.
Use twine to publish your package to PyPI.
Use PyPI to publish your package.
Use GitHub Release to track your historical assets.
It assumes the following code folder structure:
.github/workflows/main.yml # GitHub Actions CI/CD configuration file
${package_name}/
${package_name}/__init__.py
${package_name}/*.py
docs/
docs/source # documentation source folder
docs/source/conf.py # sphinx doc configuration file
tests/ # unit test folder
bin/ # development workflow automation scripts
bin/pywf.py
bin/s01_....py
bin/s02_....py
bin/...
Makefile # makefile for automation
.coveragerc # code coverage test configuration file
codecov.yml # code coverage CI rules configuration file
.readthedocs.yml # readthedocs.org configuration file
pyproject.toml # Python project configuration file, no setup.py
Project Maintainer Note¶
This project follows the best practice mentioned in THIS DOCUMENT.
Seed Repository: cookiecutter_pywf_open_source_demo-project
Automation Library: pywf_open_source-project
Cookiecutter Template: cookiecutter-pywf_open_source
Install¶
pywf_open_source is released on PyPI, so all you need is to:
$ pip install pywf-open-source
To upgrade to latest version:
$ pip install --upgrade pywf-open-source