Skip to main content

General purpose utility library

Project description

haggis

This is a library of general purpose utility functions and classes written in Python. Much of this code is intended to support the imprint project https://github.com/madphysicist/imprint. The modules of this library are more-or-less standalone utilities, organized by category.

This library contains plenty of code that relies on external programs and less common Pyhon libraries. The code is considered to be "extras", in the setuptools sense. Extras can be omitted without any modification to the python code. The following extras are supported:

  • [docx]: Support for docx file utilities requires python-docx to be installed.
  • [latex]: Supporting LaTeX requires a host of external programs to work properly, so this feature is optional. See the dependency page in the main documentation for more information.
  • [pdf]: Requires the poppler library to be installed.
  • [ps]: Requires GhostScript to be installed.
  • [plot]: Plotting tools require matplotlib, which is a heavy dependency, and unnecessary for many purposes.
  • [term]: Terminal colors work out of the box on Linux, but require the colorama library to work on Windows.
  • [scio]: Science I/O depends on the scipy and astropy libraries to deliver IDL and FITS file support, respectively.
  • [xlsx]: Support for xlsx file utilities requires openpyxl to be installed.

To install extras such as latex and pdf, do::

pip install haggis[latex,pdf]

See the documentation at https://haggis.readthedocs.io/en/latest for more information, including the API documentation.

This library in licensed under the AGPLv3, and compatible with later versions. You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Changelog

0.1a1.dev1 (2019-04-13)

  • First release on PyPI.
  • Created Read the Docs pages.
  • Only code required for imprint present initially.
  • Documentation 90% complete.
  • No tests worth speaking of.

Download files

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

Files for haggis, version 0.1a1.dev1
Filename, size File type Python version Upload date Hashes
Filename, size haggis-0.1a1.dev1-py3-none-any.whl (132.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size haggis-0.1a1.dev1.tar.gz (100.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page