Contents

Overview

docs
tests
package

General python functions and classes which could be used across multiple projects.

• Free software: BSD 3-Clause License

Installation

pip install py3helpers

You can also install the in-development version with:

pip install https://github.com/adbailey4/py3helpers/archive/master.zip

You to allow access to seq_tools, you need to install with:

pip install py3helpers[seq_tools]

Or you can install from source with:

git clone https://github.com/adbailey4/python_utils
cd python_utils
pip install -e.[seq_tools]
python setup.py test

Documentation

https://py3helpers.readthedocs.io/

Development

To run the all tests run:

tox

Installation

At the command line:

pip install py3helpers

Usage

To use py3helpers in a project:

import py3helpers

Reference

py3helpers

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

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

Documentation improvements

py3helpers could always use more documentation, whether as part of the official py3helpers docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/adbailey4/py3helpers/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up py3helpers for local development:

1. Fork py3helpers (look for the “Fork” button).

2. Clone your fork locally:

   git clone git@github.com:adbailey4/py3helpers.git
   

3. Create a branch for local development:

   git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

4. When you’re done making changes run all the checks and docs builder with tox one command:

   tox
   

5. Commit your changes and push your branch to GitHub:

   git add .
   git commit -m "Your detailed description of your changes."
   git push origin name-of-your-bugfix-or-feature
   

6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

1. Include passing tests (run tox) [1].
2. Update documentation when there’s new API, functionality etc.
3. Add a note to CHANGELOG.rst about the changes.
4. Add yourself to AUTHORS.rst.

[1]	If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request. It will be slower though …

Tips

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

To run all the test environments in parallel (you need to pip install detox):

detox

Authors

• Andrew Dewey Bailey IV - https://blog.ionelmc.ro

Changelog

0.4.0 (2020-02-27)

• First release on PyPI.

Indices and tables

• Index
• Module Index
• Search Page