Skip to main content

Generate a markfown reference from your public API docstrings and add it to your readme

Project description

referencer-py

Travis Coveralls PyPi Github

Generate a markdown reference from your public API docstrings and add it to your readme.

Features

  • Uses pydoc-markdown under the hood

Getting Started

The package uses semantic versioning. It means that major versions could include breaking changes.

$ pip install referencer

Documentation

referencer package README.md --in-place

API Reference

cli

cli(package, document, **options)

Command-line interface

Usage: referencer [OPTIONS] PACKAGE DOCUMENT

Options:
  --in-place               [default: False]
  --package-pattern TEXT   [default: from \.(\w+) import (\w+)]
  --document-section TEXT  [default: ## Reference]
  --version                Show the version and exit.
  --help                   Show this message and exit.

generate_document

generate_document(package, document, package_pattern='from \\.(\\w+) import (\\w+)', document_section='## API Reference')

Generate document

generate_reference

generate_reference(package, package_pattern='from \\.(\\w+) import (\\w+)')

Generate reference

Contributing

virtualenv .python -ppython3.7
source .python/bin/activate
make install
make test

Changelog

v0.x

  • Initial version

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

referencer-0.2.3.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

referencer-0.2.3-py2.py3-none-any.whl (6.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file referencer-0.2.3.tar.gz.

File metadata

  • Download URL: referencer-0.2.3.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.8.0

File hashes

Hashes for referencer-0.2.3.tar.gz
Algorithm Hash digest
SHA256 a38e3d87fda84d40c42c136713727c9dacb4cdf2218fa02fca8df3518e3bb3b4
MD5 31595e75dd7e3108db8ad4f02f7fbb46
BLAKE2b-256 961667d11d65150dcfde956c21aca4a987fe1b329189a55dcb550ceae36bd93f

See more details on using hashes here.

File details

Details for the file referencer-0.2.3-py2.py3-none-any.whl.

File metadata

  • Download URL: referencer-0.2.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.8.0

File hashes

Hashes for referencer-0.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f16657bb6aef5a9d3a84f018a1509fc73e579919d86ef60eca3512f8692b37ca
MD5 65b9e1bf16f75de86895d61a280aab7f
BLAKE2b-256 2c9aea9b93af8bce7690d886fd9dfb0a43e7949061e5286586e6e7af28e02e33

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page