Rooba
/
boltons
mirror of https://github.com/mahmoud/boltons.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
1,581 Commits 6 Branches 50 Tags 5.4 MiB
Commit Graph

150 Commits

Author SHA1 Message Date
Mahmoud Hashemi 06b76085c5 adding in-progress urlutils docs to sphinx 2017-03-16 00:00:52 -07:00
Mahmoud Hashemi 8640462ca3 clarify atomic file rationale 2017-03-15 09:45:34 -07:00
Mahmoud Hashemi a17ac75134 expose iterutils.research docs 2017-03-11 19:42:53 -08:00
Mahmoud Hashemi 95b1ba93f1 wrap up get_path TODOs and document it accordingly 2017-03-02 01:37:51 -08:00
Mahmoud Hashemi 0d26cbb1e9 bump docs version 2017-02-27 01:24:18 -08:00
Mahmoud Hashemi 83fcee4f2c update docs version 2017-01-24 22:54:45 -08:00
Brant Watson 7ef8e9f4d4 Fix ioutils documentation missing from index.rst 2016-11-08 15:00:50 -06:00
Mahmoud Hashemi 9f61b1b0e0 expose mathutils.clamp in docs 2016-11-06 00:18:44 -07:00
Mahmoud Hashemi edf5705e32 bump version for 16.5.1 release 2016-11-05 23:55:55 -07:00
Emanuele Cesena 6d3d2f375e Fix typo in docs index 2016-11-04 13:00:04 -07:00
Brant Watson c7fa81ccf5 Add more example documentation 2016-10-24 07:06:12 -05:00
Brant Watson 9b964c361c Added example documentation 2016-10-21 17:56:19 -05:00
Brant Watson 580142da3b Add ioutils module 
Spooled Temporary Files are file-like objects
that start out mapped to in-memory objects, but
automatically roll over to a temporary file once
they reach a certain (configurable) threshhold.
Unfortunately the built-in SpooledTemporaryFile
class in Python does not implement the exact API
that some common classes like StringIO do.
SpooledTemporaryFile also spools all of it's in-memory
files as cStringIO instances. cStringIO instances cannot
be deep-copied, and they don't work with the zip
library either. This along with the incompatible api makes
it useless for several use-cases.

To combat this but still gain the memory savings and
usefulness of a true spooled file-like-object, two custom
classes have been implemented which have a compatible API.

SpooledBytesIO is a spooled file-like-object that only
accepts bytes. On Python 2.x this means the 'str' type; on
Python 3.x this means the 'bytes' type. Bytes are written
in and retrieved exactly as given, but it will raise TypeErrors
if something other than bytes are written.

SpooledStringIO is a spooled file-like-object that only accepts
unicode values. On Python 2.x this means the 'unicode' type and
on Python 3.x this means the 'str' type. Values are accepted as
unicode and then coerced into utf-8 encoded bytes for storage. On
retrieval, the values are returned as unicode.
 2016-10-21 16:13:44 -05:00
Mahmoud Hashemi 51d2f7177d bump docs version 2016-07-19 00:44:34 -07:00
Mahmoud Hashemi e2cc7e551d couple of badges for the docs 2016-06-24 02:14:58 -07:00
Mahmoud Hashemi 7cbe37eaf9 document funcutils.wraps and funcutils.FunctionBuilder. also switch FunctionBuilder on Python 2 to be congruent with Python 3 (keywords -> varkw) 2016-06-08 02:23:51 -07:00
Mahmoud Hashemi 8ac1b08501 bump docs version 2016-05-24 10:09:33 -07:00
Mahmoud Hashemi e86b2ccf21 improve ecoutils docstrings and add it to the main doc 2016-05-23 10:08:06 -07:00
Mahmoud Hashemi 218685d3c5 add new timeutils to doctests 2016-05-21 00:26:21 -07:00
Mahmoud Hashemi 61cfe14ab9 add cachedproperty and cachedmethod to the cacheutils sphinxdoc 2016-05-17 02:31:48 -07:00
Mahmoud Hashemi 7c592152da socketutils docs minor expansion 2016-05-01 02:56:49 -07:00
Mahmoud Hashemi 4277d71306 b'friggin python3' 2016-04-28 20:46:25 -07:00
Mahmoud Hashemi 88d73c3e8b many more socketutils docs, now with an rst file for the sphinxing 2016-04-28 00:57:36 -07:00
Mahmoud Hashemi 1edb307882 always bugged me that priority queues was not capitalized the same way as other sections. 2016-04-27 23:08:30 -07:00
Mahmoud Hashemi ecbb9dd57e docs main page small update (UTC timezone and punctuation) 2016-04-27 23:07:35 -07:00
Mahmoud Hashemi da6e59f98f bump docs version 2016-04-18 23:49:35 -07:00
Mahmoud Hashemi 91e629a1df bump docs version to 16.1.2 2016-03-06 15:41:45 -08:00
Mahmoud Hashemi d0b8d2e2b1 add iterutils.same() to the docs, creating a new documentation section 'Reduction' 2016-03-06 15:31:23 -08:00
Mahmoud Hashemi a9643c20aa docs and CHANGELOG updates 2016-02-24 02:36:17 -08:00
Mahmoud Hashemi 539227e260 continuing to debug RTD issue #1692 2015-09-24 12:21:51 -07:00
Mahmoud Hashemi 0c362c5cee debugging RTD issue #1692 2015-09-24 12:14:34 -07:00
Mahmoud Hashemi 492f607b85 debugging a read the docs issue 2015-09-24 11:59:44 -07:00
Mahmoud Hashemi 5c79a8a62d a bunch of docs cleanups 2015-09-24 11:51:21 -07:00
Mahmoud Hashemi 275a290ea7 docs tweak for nested iterutils intro 2015-09-24 03:36:22 -07:00
Mahmoud Hashemi 3e4952ca61 adding remap link to docs home page 2015-09-24 03:00:56 -07:00
Mahmoud Hashemi bfe39cb4ae docs version bump 2015-09-24 03:00:45 -07:00
Mahmoud Hashemi 0d6486c402 exposing remap docs 2015-09-21 02:40:33 -07:00
Mahmoud Hashemi 1ff59e75ad separate out numeric iteration utilities from iterable-based iteration utilities 2015-09-19 00:44:18 -07:00
Mahmoud Hashemi 8632ef63e7 centralize docs requirements 2015-09-19 00:22:01 -07:00
Kevin Stone a2d97137df Missing docs for unique and unique_iter 2015-09-18 13:46:38 -07:00
Mahmoud Hashemi 6c66358422 linking the changelog from the README and the docs 2015-08-23 05:52:51 -07:00
Mahmoud Hashemi 76e47cd139 cacheutils docs updates 2015-08-22 16:49:05 -07:00
Mahmoud Hashemi e81916c6b8 bumping sphinx docs version 2015-08-19 01:34:15 -07:00
Mahmoud Hashemi 6bb6a134c9 adding backoff function for consistency with rest of iterutils module 2015-08-19 01:15:21 -07:00
Mahmoud Hashemi 89a55103fe updating iterutils docs to display new numeric iterators 2015-08-19 01:05:03 -07:00
Mahmoud Hashemi e1d724d833 first implementation of dt_to_timestamp, per the long-lived PR #13. Also a few docs fixes. 2015-08-16 19:25:58 -07:00
Mahmoud Hashemi 027865d9ce merging tzutils into timeutils, lots of little timeutils docs enhancements 2015-08-16 18:47:06 -07:00
Hynek Schlawack 08cb8496e8 Add first function 
Transplant from https://github.com/hynek/first , hereby donated. :)
 2015-07-30 11:10:06 +02:00
Mahmoud Hashemi 414419dd19 expose iterutils.one docs 2015-07-30 01:58:47 -07:00
Mahmoud Hashemi 42996c48c6 name change per discussion in #40 2015-07-17 13:52:44 -07:00
Mahmoud Hashemi 6bc4e9f315 Merge pull request #40 from siemens/collection 
new is_container function
 2015-07-17 13:44:27 -07:00
Mahmoud Hashemi e2e5094bf6 updated ThresholdCounter with a bunch of functionality and docs 2015-06-30 23:08:52 -07:00
Mahmoud Hashemi 5b78fecfb9 bump docs version, improve queueutils docs 2015-06-07 22:35:19 -07:00
Eric L Frederich 8ec9395945 new is_container function 2015-05-21 09:11:32 -04:00
Eric L Frederich 28715b4de4 use functions instead of lambdas for documentation 2015-05-18 18:58:36 -04:00
Adam f3fc4d0638 Update function names in mathutils.rst. 2015-04-30 21:55:29 +08:00
Mahmoud Hashemi 709f935693 shorter mathutils heading to make for a nicer TOC 2015-04-29 01:20:44 -07:00
Mahmoud Hashemi c1a14b88c0 update architecture statement after reflection on recent pull requests post-release 2015-04-29 01:06:57 -07:00
Adam Gibson b6f61b8d8b Ceil/floor function re-implementation using bisect. Corrections and updates to unittests and documentation. 2015-04-27 17:16:54 +08:00
Adam Gibson 5a3039f7a6 Refactored ceil/floor function name and signature. Updated docs accordingly. 2015-04-27 11:57:53 +08:00
Adam Gibson 6817ba0c1f Add mathutils to index.rst. 2015-04-27 11:57:53 +08:00
Adam Gibson ba3f91bddd New module for math utilities. Includes alternative ceiling/floor functions. 2015-04-27 11:57:53 +08:00
Mahmoud Hashemi a7afa9bde6 adding typeutils docs 2015-04-16 01:56:05 -07:00
Mahmoud Hashemi 266c968b5e windowed() -> windowed in index 2015-04-16 00:29:00 -07:00
Mahmoud Hashemi 94a6fcfd43 read the docs has google analytics support built in! 2015-04-13 00:20:00 -07:00
Mahmoud Hashemi 47e4278db7 adding a bit of the old (i,s,o,g,r,a,m) to the docs 2015-04-12 22:10:28 -07:00
Mahmoud Hashemi f968628a34 add python versions to index.rst 2015-04-11 03:14:15 -07:00
Mahmoud Hashemi 2810b97eae adding github stars to docs menu 2015-04-11 03:12:32 -07:00
Mahmoud Hashemi 6061a7ccbf fix a link and update the docs nominal version (should automate this) 2015-04-09 14:34:58 -07:00
Mahmoud Hashemi 3d5336c155 tweak links in index.rst 2015-04-09 00:36:48 -07:00
Mahmoud Hashemi aee394a5f4 tweaking index copy and adding proper linkage 2015-04-08 21:24:57 -07:00
Mahmoud Hashemi 6fbaa8cc26 minor update to date format 2015-04-08 21:24:37 -07:00
Mahmoud Hashemi 7c66eed238 linking themes and adding architecture info blurb 2015-04-08 21:24:17 -07:00
Mahmoud Hashemi b22608e63d index docs tweaks 2015-04-07 20:18:16 -07:00
Mahmoud Hashemi d5733ed9e8 hooray epilog replace. boltons now advertises its stats (might need to find a better place for them tho) 2015-04-07 02:39:47 -07:00
Mahmoud Hashemi 9145a4fb92 added the facilities necessary to automatically document how many modules, types, and functions there are in boltons. 2015-04-07 02:20:28 -07:00
Mahmoud Hashemi 9208ec53e0 splitting out the architecture into a separate document 2015-04-07 01:21:59 -07:00
Mahmoud Hashemi b801d2d762 WIP index.rst refresh 2015-04-06 02:36:58 -07:00
Mahmoud Hashemi ba5bd15658 setutils docs WIP 2015-04-05 23:56:13 -07:00
Mahmoud Hashemi cc364279da iterutils refresh. argname change: keyfunc -> key. docs reviewed and updated. 2015-04-05 19:12:15 -07:00
Mahmoud Hashemi 7f4d816dc9 funcutils doc refresh 2015-04-05 18:29:02 -07:00
Mahmoud Hashemi 2337022f19 fileutils docs complete 2015-04-05 15:01:20 -07:00
Mahmoud Hashemi d90c2f62d2 fix all remaining modules' headings 2015-04-04 21:30:09 -07:00
Mahmoud Hashemi 99bfce33fd debugutils docs refresh 2015-04-04 21:09:59 -07:00
Mahmoud Hashemi aec87c8fd1 documenting 'cached' decorator 2015-04-04 20:54:20 -07:00
Mahmoud Hashemi 390a812b14 more cacheutils docs tweaks (headings this time) 2015-04-04 20:19:36 -07:00
Mahmoud Hashemi 8d40da7cab rearranging the cacheutils docs 2015-04-04 16:11:43 -07:00
Mahmoud Hashemi 3ff1ec0c25 tzutils docs and docstrings 2015-04-03 01:49:21 -07:00
Mahmoud Hashemi 8e55d2b676 documenting tbutils 2015-04-01 21:15:42 -07:00
Mahmoud Hashemi c339d1b835 well that didn't fix it 2015-03-31 01:10:36 -07:00
Mahmoud Hashemi c472c3a5d0 now trying to fix RTD theme breakage 2015-03-31 01:07:32 -07:00
Mahmoud Hashemi 57560c7abb napoleon/ReadTheDocs sphinx version fix 2015-03-31 00:45:28 -07:00
Mahmoud Hashemi 17f09bd85f set a version requirement for sphinx 2015-03-30 21:04:35 -07:00
Mahmoud Hashemi 07bbfed644 Enable napoleon for docstrings. 2015-03-30 20:56:34 -07:00
Mahmoud Hashemi bee2ecce5a progress on intersphinxin 2015-03-25 01:07:29 -07:00
Mahmoud Hashemi 8e83bbb8c0 removing osutils and adding a note about utils in general 2015-03-23 02:54:48 -07:00
Mahmoud Hashemi 690dff1e77 fix numbering 2015-03-22 11:47:38 -07:00
Mahmoud Hashemi 38ffbf115b add notes about boltons usage 2015-03-22 02:56:24 -07:00
Mahmoud Hashemi f56aa8bf2b updated headings for all the modules, thinking about merging osutils and fileutils 2015-03-21 23:18:45 -07:00
Mahmoud Hashemi 01d479ba6b adding initial docs 2015-03-21 17:12:50 -07:00