Welcome to py_tools’s documentation!

py_tools

Features

Current features include:

• conda ready

• pytest unit test

• continous integration

• coverall code coverage

• documentation with sphinx

• documentation on readthedocs

Installation

todo

Usage

To use py_tools in a project:

import py_tools

Examples

This is my example script

This is my example script

This example doesn’t do much, it just makes a simple plot

This is a section header

This is the first section! The #%% signifies to Sphinx-Gallery that this text should be rendered as rST and if using one of the above IDE/plugin’s, also signifies the start of a ‘code block’.

import py_tools

# This line won't be rendered as rST because there's a space after the last block.
myvariable = 2
print("my variable is {}".format(myvariable))
# This is the end of the 'code block' (if using an above IDE). All code within
# this block can be easily executed all at once.

Out:

my variable is 2

This is another section header

In the built documentation, it will be rendered as rST after the code above! This is also another code block.

print('my variable plus 2 is {}'.format(myvariable + 2))

Out:

my variable plus 2 is 4

This is another section header

Plots look nice in examples

import matplotlib.pyplot as plt

plt.plot([1,23,2,4])
plt.ylabel('some numbers')

plt.show()

API

py_tools

py_tools package

Subpackages

py_tools.cli package

Submodules

py_tools.cli.main module

Module contents

Submodules

py_tools.version module

Module contents

py_tools.pure_python()

hello

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/DerThorsten/py_tools/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

py_tools could always use more documentation, whether as part of the official py_tools 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/DerThorsten/py_tools/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 :)

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 / classes with a proper documentation, and add the feature to the list in README.rst.

Credits

Development Lead

• Thorsten Beier <derthorstenbeier@gmail.com>

Contributors

None yet. Why not be the first?

History

0.1.0 (2019-10-07)

• First release on PyPI.

Indices and tables

• Index

• Module Index

• Search Page