API Reference

__author__ module-attribute

__author__ = 'Peter Yuen'

__email__ module-attribute

__email__ = 'ppeetteerrsx@gmail.com'

__version__ module-attribute

__version__ = metadata.version('simple_poetry')

__docs

__docs()

Build gh-pages documentation branch.

Source code in simple_poetry/__init__.py

def __docs():  # pragma: no cover
    """
    Build gh-pages documentation branch.
    """
    shell(
        "cp README.md docs/index.md && \
            mkdocs gh-deploy --force"
    )

__serve

__serve()

Serve local documentation.

Source code in simple_poetry/__init__.py

def __serve():  # pragma: no cover
    """
    Serve local documentation.
    """
    shell(
        "cp README.md docs/index.md && \
            mkdocs serve"
    )

__test

__test()

Runs pytest locally and keeps only coverage.xml for GitHub Actions to upload to Codecov.

Source code in simple_poetry/__init__.py

def __test():  # pragma: no cover
    """
    Runs pytest locally and keeps only `coverage.xml` for GitHub Actions to upload to Codecov.
    """
    shell(
        "pytest --cov=simple_poetry --cov-report xml --cov-report term-missing tests \
            && rm -rf .pytest_cache && rm .coverage"
    )