pyin

Like sed, but Python! A personal project.

Contents

• Documentation
• Installing
• Developing

Documentation

See docs.rst.

Documentation is built with docutils, which is much lighter than Sphinx, but also has far fewer directives. It does support rendering a single reStructuredText file as a single HTMl file though. The project provides a helpful cheatsheet.

Installing

$ python3 -m pip install git+https://github.com/geowurster/pyin

Developing

# Set up workspace
$ git clone https://github.com/geowurster/pyin
$ cd pyin
$ python3 -m venv venv
$ source venv/bin/activate

# Upgrade packaging tools
$ (venv) pip install pip setuptools --upgrade

# Dev and test dependencies
$ (venv) pip install -r requirements-dev.txt -e ".[test]"

# Run tests
$ (venv) pytest --cov pyin --cov-report term-missing --cov-fail-under 100

# Optionally, 'tox' can be used to test on multiple Python versions
$ (venv) tox