1. User Guide

This section of the documentation provides user focused information such as installing and quickly using this package.

1.1. Install Guide

Note

It is best practice to install run Python projects in a virtual environment, which can be created and activated as follows using Python 3.6+.

$ python -m venv venv
$ source venv/bin/activate
(venv) $ pip install gestalt

The simplest way to install Gestalt is using Pip.

$ pip install gestalt

This will install gestalt and all of its dependencies.

1.2. API Reference

The API Reference provides API-level documentation.

A record of significant changes can be found in the change log.

1.2.1. Change Log

Notable changes to this project will be documented in this file.

1.2.1.1. Version History

1.2.1.1.1. 20.1.0
  • Update package to support Python3.8
  • Use yarl package for URLs.
  • Add linting to improve code sustainment.
  • Fix bug in stream protocols that affected msg_len in scenarios where messages were fragmented.
1.2.1.1.2. 19.9.2
  • Fix markdown displayed on PyPI.
1.2.1.1.3. 19.9.1
  • Adopted CalVer for package versioning.
  • Initial functionality release.
  • Clean up type annotation to remove all Mypy errors.
  • Add Mypy type check to CI.
  • Improve unit test code coverage.
1.2.1.1.4. 0.2.0
  • Added basic functionality.
1.2.1.1.5. 0.0.1
  • Project created.

1.3. Report Bugs

Report bugs at the issue tracker.

Please include:

  • Operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.