<commit_before>pyinter  [![Build Status](https://travis-ci.org/intiocean/pyinter.png)](https://travis-ci.org/intiocean/pyinter)
=======

The what?
---------
An interval package for Python which deals with interval arithmetic and sets of intervals *(discontinuous ranges)*. **It is currently in developement and not yet fully code complete or fully tested.**

The how?
--------
I Started development of this library on a weekend. Initially, I have just implemented features which I wanted to use and a couple of others which it felt natural to include.

The why?
--------
*Warning: the following may or may not be rather geeky, you have been warned!* The inital reason I started developement of an interval package in python was that I couldn't find one which dealt with open and closed intervals and I needed one to play around with some ideas I was having regarding dependency resolution of python packages.

The help
--------
Documentation is available here: http://pyinter.readthedocs.org

Done
----
- interval objects which can be
    - unioned
    - intersected
    - easily constructed using helper functions: *open, closed, openclosed and closedopen*
- interval sets which can be
    - unioned
    - intersected
- tests on interval
    - construction
    - comparison
    - intersection and union
- tests on interval set
    - construction
    - comparison
    - intersection and union
- sphinx documentation available here: http://pyinter.readthedocs.org
- continous integration on travis ci: https://travis-ci.org/intiocean/pyinter
- Example use: daterange
- add to pypi
- remove pylint
- add a build for python 3.3 to travis ci and get it passing (there is some kind of import error)

Todos
-----
- How to install added to docs
- make the project a homepage
- Create a version range as a concrete usable example
- ensure all functions have docstrings describing the inputs and outputs
- look for enhancements to the code (timing, optimisation, tidying of interval_set ...)
<commit_msg>readme changes only<commit_after>pyinter  [![Build Status](https://travis-ci.org/intiocean/pyinter.png)](https://travis-ci.org/intiocean/pyinter)
=======

The what?
---------
An interval package for Python which deals with interval arithmetic and sets of intervals *(discontinuous ranges)*. **It is currently in developement and not yet fully code complete or fully tested.**

The how?
--------
I Started development of this library on a weekend. Initially, I have just implemented features which I wanted to use and a couple of others which it felt natural to include.

The why?
--------
*Warning: the following may or may not be rather geeky, you have been warned!* The inital reason I started developement of an interval package in python was that I couldn't find one which dealt with open and closed intervals and I needed one to play around with some ideas I was having regarding dependency resolution of python packages.

The help
--------
Documentation is available here: http://pyinter.readthedocs.org

Done
----
- interval objects which can be
    - unioned
    - intersected
    - easily constructed using helper functions: *open, closed, openclosed and closedopen*
- interval sets which can be
    - unioned
    - intersected
- tests on interval
    - construction
    - comparison
    - intersection and union
- tests on interval set
    - construction
    - comparison
    - intersection and union
- sphinx documentation available here: http://pyinter.readthedocs.org
- continous integration on travis ci: https://travis-ci.org/intiocean/pyinter
- Example use: daterange
- add to pypi
- remove pylint
- add a build for python 3.3 to travis ci and get it passing (there is some kind of import error)

Todos
-----
- How to install added to docs
- make the project a homepage
- Create a version range as a concrete usable example
- ensure all functions have docstrings describing the inputs and outputs
- Convert this readme to RST so that it renders properly on pypi

{'fraction_non_alphanumeric': 0.07928517493078278, 'fraction_numerical': 0.0010067958721369243, 'mean_word_length': 3.4451901565995526, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1476637', 'n_tokens_mistral': 1033, 'n_tokens_neox': 1004, 'n_words': 519}