Skip to main content

Toolbox for Python scripts

Project description

https://badge.fury.io/py/pytoolbox.png https://secure.travis-ci.org/davidfischer-ch/pytoolbox.png https://coveralls.io/repos/davidfischer-ch/pytoolbox/badge.png https://landscape.io/github/davidfischer-ch/pytoolbox/master/landscape.png 'Stories in Ready'

Afraid of red status ? Please click on the link, sometimes this is not my fault ;-)

This module is a Toolbox for Python scripts.

Documentation: https://pytoolbox.readthedocs.org

Repository: https://github.com/davidfischer-ch/pytoolbox

This library supports Python 2.7, 3.3, 3.4, 3.5, 3.6 and PyPy. And try to support 2.6 and 3.2, see Travis CI build matrix.

What the release number stands for ?

I do my best to follow this interesting recommendation : Semantic Versioning 2.0.0

How to install it (Python 2.7) ?

Install some packages that are not handled by pip:

sudo apt-get install gir1.2-gexiv2-0.10 libexiv2-dev liblzma-dev libxml2-dev libxslt-dev libyaml-dev libz-dev
sudo apt-get install ffmpeg git-core python-dev python-gi python-pip screen

Make sure that pip is up-to-date (PIPception):

sudo pip-2.7 install --upgrade pip

Then, you only need to run setup.py:

python2 setup.py test
sudo python2 setup.py install

How to install it (Python 3.5) ?

Install some packages that are not handled by pip:

sudo apt-get install gir1.2-gexiv2-0.10 libexiv2-dev liblzma-dev libxml2-dev libxslt-dev libyaml-dev libz-dev
sudo apt-get install ffmpeg git-core python3-dev python3-gi python3-pip screen

Make sure that pip is up-to-date (PIPception):

sudo pip-3.5 install --upgrade pip

Then, you only need to run setup.py:

python3 setup.py test
sudo python3 setup.py install

How to enable features/modules ?

Example:

python setup.py install --help

Common commands: (see '--help-commands' for more)

  setup.py build      will build the package underneath 'build/'
  setup.py install    will install the package

Global options:
  --verbose (-v)  run verbosely (default)
  --quiet (-q)    run quietly (turns verbosity off)
  --dry-run (-n)  don't actually do anything
  --help (-h)     show detailed help message
  --no-user-cfg   ignore pydistutils.cfg in your home directory

Options for 'WithExtra' command:
  --prefix                             installation prefix
  --exec-prefix                        (Unix only) prefix for platform-specific files
  --home                               (Unix only) home directory to install under
  --user                               install in user site-package '...'
  --install-base                       base installation directory (instead of --prefix or --home)
  --install-platbase                   base installation directory for platform-specific files (...)
  --root                               install everything relative to this alternate root directory
  --install-purelib                    installation directory for pure Python module distributions
  --install-platlib                    installation directory for non-pure module distributions
  --install-lib                        installation directory for all module distributions (...)
  --install-headers                    installation directory for C/C++ headers
  --install-scripts                    installation directory for Python scripts
  --install-data                       installation directory for data files
  --compile (-c)                       compile .py to .pyc [default]
  --no-compile                         don't compile .py files
  --optimize (-O)                      also compile with optimization: -O1 for "python -O", (...)
  --force (-f)                         force installation (overwrite any existing files)
  --skip-build                         skip rebuilding everything (for testing/debugging)
  --record                             filename in which to record list of installed files
  --install-layout                     installation layout to choose (known values: deb, unix)
  --old-and-unmanageable               Try not to use this!
  --single-version-externally-managed  used by system package builders to create 'flat' eggs

  --extra-all                          Install dependencies for all features.
  --extra-atlassian                    Install dependencies for the feature atlassian.
  --extra-django                       Install dependencies for the feature django.
  --extra-django-filter                Install dependencies for the feature django_filter.
  --extra-django-formtools             Install dependencies for the feature django_formtools.
  --extra-flask                        Install dependencies for the feature flask.
  --extra-imaging                      Install dependencies for the feature imaging.
  --extra-jinja2                       Install dependencies for the feature jinja2.
  --extra-logging                      Install dependencies for the feature logging.
  --extra-mongo                        Install dependencies for the feature mongo.
  --extra-network                      Install dependencies for the feature network.
  --extra-rest-framework               Install dependencies for the feature rest_framework.
  --extra-selenium                     Install dependencies for the feature selenium.
  --extra-smpte2022                    Install dependencies for the feature smpte2022.
  --extra-unittest                     Install dependencies for the feature unittest.
  --extra-voluptuous                   Install dependencies for the feature voluptuous.

usage: setup.py [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]
   or: setup.py --help [cmd1 cmd2 ...]
   or: setup.py --help-commands
   or: setup.py cmd --help


sudo python setup.py install --extra-smpte2022

Another way to do this, with pip:

sudo pip install -e .[django,flask,mongo,smpte2022] --use-mirrors

How to check coverage ?

python setup.py test
xdg-open tests/cover/index.html

Remarks:

  • All Django related modules are excluded from tests!
  • However I am using them with Django up to 1.11.8.

How to use it ?

Here is an example hello.py using the cmd function provided by pytoolbox:

from pytoolbox.subprocess import cmd

print(cmd('echo Hello World!')['stdout'])

How to generate documentation ?

The documentation is generated by Sphinx. In fact most of this documentation is extracted from the docstrings of the code.

Here is the procedure:

python setup.py docs
xdg-open docs/build/html/index.html

How to add it to dependencies of my own project ?

Here is an example setup.py for a project called my-cool-project:

from setuptools import setup

setup(name='my-cool-project',
          version='0.8',
          author='Firstname Lastname',
          author_email='author@something.com',
          install_requires=['...', 'pytoolbox', '...'],
          tests_require=['nose'],
          license='GPLv3',
          url='https://github.com/nickname/my-cool-project',
          packages=['my_cool_project'])

See pip vcs support to get further details about this.

You also need to install git-core, but it is probably already the case, at least on your development computer ;-)

2014 - David Fischer

Release history Release notifications

This version
History Node

11.9.0

History Node

11.8.6

History Node

11.8.5

History Node

11.8.4

History Node

11.8.3

History Node

11.8.2

History Node

11.8.1

History Node

11.8.0

History Node

11.7.6

History Node

11.7.5

History Node

11.7.3

History Node

11.7.2

History Node

11.7.1

History Node

11.7.0

History Node

11.6.4

History Node

11.6.3

History Node

11.6.2

History Node

11.6.1

History Node

11.6.0

History Node

11.5.4

History Node

11.5.3

History Node

11.5.1

History Node

11.5.0

History Node

11.4.3

History Node

11.4.2

History Node

11.4.1

History Node

11.4.0

History Node

11.2.0

History Node

11.1.0

History Node

11.0.0

History Node

10.4.0

History Node

10.3.0

History Node

10.2.0

History Node

10.1.0

History Node

10.0.0

History Node

9.7.0

History Node

9.6.1

History Node

9.4.2

History Node

9.4.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pytoolbox-11.9.0.tar.gz (128.6 kB) Copy SHA256 hash SHA256 Source None Jun 5, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page