Python 3 utility library
Project description
Chicken Turtle Util (CTU) is a broad scoped Python utility library.
Most dependencies are optional and grouped by module. When using a
module, add/install its dependencies, listed in its corresponding
``*_requirements.in`` file found in the root of the project; e.g.
`cli\_requirements.in <https://github.com/timdiels/chicken_turtle_util/blob/master/cli_requirements.in>`__
lists the dependencies of chicken\_turtle\_util.cli.
Links
=====
- `Documentation <http://pythonhosted.org/chicken_turtle_util/>`__
- `PyPI <https://pypi.python.org/pypi/chicken_turtle_util/>`__
- `GitHub <https://github.com/timdiels/chicken_turtle_util/>`__
API stability
=============
While all features are documented and tested, the API is changed
frequently. When doing so, the `major version <semver_>`__ is bumped and
a changelog is kept to help upgrade. Fixes will not be backported. It is
recommended to pin the major version in your setup.py, e.g. for 2.x.y:
::
install_requires = ['chicken_turtle_util>=2.0.0,<3.0.0', ...]
If you see something you like but need long term stability (e.g. if low
maintenance cost is required), request to have it moved to a stable
library (one with fewer major releases) by `opening an
issue <https://github.com/timdiels/chicken_turtle_util/issues>`__.
Changelog
=========
`Semantic versioning <semver_>`__ is used (starting with v3.0.0).
v3.0.0
------
- Removed:
- cli.Context, cli.BasicsMixin, cli.DatabaseMixin,
cli.OutputDirectoryMixin
- pyqt module
- URL\_MAX\_LENGTH
- various module: Object, PATH\_MAX\_LENGTH
- Enhanced:
- \`data\_frame.split\_array\_like\`: columns defaults to
``df.columns``
- \`sqlalchemy.pretty\_sql\`: much better formatting
- Added:
- \`algorithms.toset\_from\_tosets\`: Create totally ordered set
(toset) from tosets
- \`configuration.ConfigurationLoader\`: loads a single
configuration from one or more files directory according to XDG
standards
- \`data\_frame.assert\_equals\`: Assert 2 data frames are equal
- \`data\_frame.equals\`: Get whether 2 data frames are equal
- \`dict.assign\`: assign one dict to the other through mutations
- \`exceptions.InvalidOperationError\`: raise when an operation is
illegal/invalid, regardless of the arguments you throw at it (in
the current state).
- \`inspect.call\_args\`: Get function call arguments as a single
dict
- \`observable.Set\`: set which can be observed for changes
- \`path.chmod\`: change file or directory mode bits (optionally
recursively)
- \`path.digest\`: Get SHA512 checksum of file or directory
- \`path.read\`: get file contents
- \`path.remove\`: remove file or directory (recursively), unless
it's missing
- \`path.write\`: create or overwrite file with contents
- \`series.assert\_equals\`: Assert 2 series are equal
- \`series.equals\`: Get whether 2 series are equal
- \`series.split\`: Split values
- \`test.temp\_dir\_cwd\`: pytest fixture that sets current working
directory to a temporary directory
v2.0.4
------
No changelist
Most dependencies are optional and grouped by module. When using a
module, add/install its dependencies, listed in its corresponding
``*_requirements.in`` file found in the root of the project; e.g.
`cli\_requirements.in <https://github.com/timdiels/chicken_turtle_util/blob/master/cli_requirements.in>`__
lists the dependencies of chicken\_turtle\_util.cli.
Links
=====
- `Documentation <http://pythonhosted.org/chicken_turtle_util/>`__
- `PyPI <https://pypi.python.org/pypi/chicken_turtle_util/>`__
- `GitHub <https://github.com/timdiels/chicken_turtle_util/>`__
API stability
=============
While all features are documented and tested, the API is changed
frequently. When doing so, the `major version <semver_>`__ is bumped and
a changelog is kept to help upgrade. Fixes will not be backported. It is
recommended to pin the major version in your setup.py, e.g. for 2.x.y:
::
install_requires = ['chicken_turtle_util>=2.0.0,<3.0.0', ...]
If you see something you like but need long term stability (e.g. if low
maintenance cost is required), request to have it moved to a stable
library (one with fewer major releases) by `opening an
issue <https://github.com/timdiels/chicken_turtle_util/issues>`__.
Changelog
=========
`Semantic versioning <semver_>`__ is used (starting with v3.0.0).
v3.0.0
------
- Removed:
- cli.Context, cli.BasicsMixin, cli.DatabaseMixin,
cli.OutputDirectoryMixin
- pyqt module
- URL\_MAX\_LENGTH
- various module: Object, PATH\_MAX\_LENGTH
- Enhanced:
- \`data\_frame.split\_array\_like\`: columns defaults to
``df.columns``
- \`sqlalchemy.pretty\_sql\`: much better formatting
- Added:
- \`algorithms.toset\_from\_tosets\`: Create totally ordered set
(toset) from tosets
- \`configuration.ConfigurationLoader\`: loads a single
configuration from one or more files directory according to XDG
standards
- \`data\_frame.assert\_equals\`: Assert 2 data frames are equal
- \`data\_frame.equals\`: Get whether 2 data frames are equal
- \`dict.assign\`: assign one dict to the other through mutations
- \`exceptions.InvalidOperationError\`: raise when an operation is
illegal/invalid, regardless of the arguments you throw at it (in
the current state).
- \`inspect.call\_args\`: Get function call arguments as a single
dict
- \`observable.Set\`: set which can be observed for changes
- \`path.chmod\`: change file or directory mode bits (optionally
recursively)
- \`path.digest\`: Get SHA512 checksum of file or directory
- \`path.read\`: get file contents
- \`path.remove\`: remove file or directory (recursively), unless
it's missing
- \`path.write\`: create or overwrite file with contents
- \`series.assert\_equals\`: Assert 2 series are equal
- \`series.equals\`: Get whether 2 series are equal
- \`series.split\`: Split values
- \`test.temp\_dir\_cwd\`: pytest fixture that sets current working
directory to a temporary directory
v2.0.4
------
No changelist
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
chicken_turtle_util-3.0.0.tar.gz
(49.4 kB
view hashes)
Close
Hashes for chicken_turtle_util-3.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e886af3d4672a892229c991fd0237c9284fdd5a888a3e84014809b71a156195 |
|
MD5 | 1c2d2c526d3ce2dcfab5304944ae9b0c |
|
BLAKE2b-256 | ce6678f27fd316fafcbf17e39cc8807e1d5515532d0ed38d2ddd9adecb4f8f30 |