README.rst

pennsieve-python

Python client and command line tool for Pennsieve.

Installation

To install, run

pip install -U pennsieve

See the installation notes for more details.

Release

To release, you should:

• Change CHANGELOG.md with the proper changes for the release
• Modify the version in __init.py__
• Merge the branch into master
• Create a new Github Release

Documentation

Client and command line documentation can be found on Pennsieve’s documentation website.

You can also contribute to Pennsieve's documentation to improve this project and help others learn.

Tests

Install the test requirements before running pytest:

make install
pytest

To run the Pennsieve CLI Agent integration tests, you need to install the agent and run the tests with the --agent argument:

pytest --agent

Contribution

Please make sure to read the Contributing Guide before making a pull request.

Changelog

Changes for each release are documented in the release notes.