gp-libs 0.0.1a1

Internal utilities for projects following git-pull python package spec

gp-libs ·

You probably don't need these. These are internal helpers that are getting dogfooded on projects following git-pull's python package patterns, e.g. any python packages in cihai, vcs-python, or tmux-python. They're unstable (APIs can change without warning). When stabilized they can be broken off into separate packages, merged upstream, etc.

doctest helpers (for docutils)

Two parts:

1. doctest module: Same specification as doctest, but can parse reStructuredText and markdown
2. pytest plugin: Collects pytest for reStructuredText and markdown files

doctest module

...

This extends standard library doctest to support anything docutils can parse. It can parse reStructuredText (.rst) and markdown (.md).

It supports two barebones directives:

• docutils' doctest_block

  >>> 2 + 2
  4
  

• .. doctest:: directive

  reStructuredText:

  .. doctest::
  
     >>> 2 + 2
     4
  

  Markdown (requires myst-parser):

  ```{doctest}
  >>> 2 + 2
  4
  ```
  

pytest plugin

...

This plugin integrates with the above module.

$ pytest docs/

Like the above module, it supports docutils' own doctest_block and a basic .. doctest:: directive.

sphinx plugins

Plain-text issue linker

We need to parse plain text, e.g. #99999, to point to the project tracker at https://github.com/git-pull/gp-libs/issues/99999. This way the markdown looks good anywhere you render it, including GitHub and GitLab.

Table of contents for autodoc

sphinx.ext.autodoc doesn't link objects in the table of contents. So we need a plugin to help.

Install

$ pip install --user gp-libs

Developmental releases

You can test the unpublished version of g before its released.

• pip:

  $ pip install --user --upgrade --pre gp-libs
  

More information

• Python support: >= 3.7, pypy
• Source: https://github.com/git-pull/gp-libs
• Docs: https://gp-libs.git-pull.com
• Changelog: https://gp-libs.git-pull.com/history.html
• API: https://gp-libs.git-pull.com/api.html
• Issues: https://github.com/git-pull/gp-libs/issues
• Test Coverage: https://codecov.io/gh/git-pull/gp-libs
• pypi: https://pypi.python.org/pypi/gp-libs
• License: MIT.