Welcome to Snakypy Helpers documentation!

Snakypy Helpers

Tests PyPI - Snakypy Helpers PyPI - Wheel Python versions Black Isort Mypy Documentation Status Updates Contributors GitHub issues Github License

Snakypy Helpers is a package that contains code ready to assist in the development of Snakypy projects, so as not to replicate the code.

Donation

Click on the image below to be redirected the donation forms:

https://raw.githubusercontent.com/snakypy/donations/master/svg/donate/donate-hand.svg

License

The project is available as open source under the terms of the MIT license © William Canin

Credits

See in AUTHORS.

Installation

Stable release

To install Snakypy, run this command in your terminal:

$ pip install snakypy-helpers

This is the preferred method to install Snakypy, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for Snakypy can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/snakypy/snakypy

Or download the tarball:

$ curl -OJL https://github.com/snakypy/snakypy/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Modules

Modules

Subpackage “helpers.ansi”

Subpackage “helpers.calcs”

Module “bmi”
Module “math”

Subpackage “helpers.catches”

Module “finders”
Module “generic”

Subpackage “helpers.console”

Module “display”

Subpackage “helpers.decorators”

Subpackage “helpers.files”

Module “json”
Module “generic”

Subpackage “helpers.logging”

Subpackage “helpers.os”

Module “removals”

Subpackage “helpers.path”

Subpackage “helpers.subprocess”

Contributing

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

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/snakypy/snakypy-helpers/issues.

If you are 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.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

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

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/snakypy/snakypy-helpers/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 contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up snakypy-helpers for local development.

  1. Fork the snakypy-helpers repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/snakypy-helpers.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv snakypy-helpers
$ cd snakypy-helpers/
$ python setup.py develop

  4. Create a branch for local development:

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

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests:

    $ python setup.py test or pytest

    To get flake8, just pip install them into your virtualenv.

  6. 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

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.

  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.

  3. The pull request should work for Python 3.5, 3.6, 3.7 3.8 and 3.9, and for PyPy. Check

    and make sure that the tests pass for all supported Python versions.

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

Contributors

None yet. Why not be the first?

Indices and tables