bucket_DD/python-smmap

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-smmap
   4 VERSION=                5.0.0
   5 KEYWORDS=               python
   6 VARIANTS=               py39 py310
   7 SDESC[py310]=           Sliding window memory map manager (3.10)
   8 SDESC[py39]=            Sliding window memory map manager (3.9)
   9 HOMEPAGE=               https://github.com/gitpython-developers/smmap
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/6d/01/7caa71608bc29952ae09b0be63a539e50d2484bc37747797a66a60679856
  14 DISTFILE[1]=            smmap-5.0.0-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[py310]=           single
  17 SPKGS[py39]=            single
  18
  19 OPTIONS_AVAILABLE=      PY39 PY310
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py310]=           PY39=OFF PY310=ON
  22 VOPTS[py39]=            PY39=ON PY310=OFF
  23
  24 DISTNAME=               smmap-5.0.0.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY39].USES_ON=                         python:py39,wheel
  29
  30 [PY310].USES_ON=                        python:py310,wheel
  31
  32 [FILE:2868:descriptions/desc.single]
  33 ## Motivation
  34
  35 When reading from many possibly large files in a fashion similar to random
  36 access, it is usually the fastest and most efficient to use memory maps.
  37
  38 Although memory maps have many advantages, they represent a very limited
  39 system resource as every map uses one file descriptor, whose amount is
  40 limited per process. On 32 bit systems, the amount of memory you can have
  41 mapped at a time is naturally limited to theoretical 4GB of memory, which
  42 may not be enough for some applications.
  43
  44 ## Limitations
  45
  46 * **System resources (file-handles) are likely to be leaked!** This is due
  47 to the library authors reliance on a deterministic `__del__()` destructor.
  48 * The memory access is read-only by design.
  49
  50 ## Overview
  51
  52 ![Python package]
  53
  54 Smmap wraps an interface around mmap and tracks the mapped files as well as
  55 the amount of clients who use it. If the system runs out of resources, or
  56 if a memory limit is reached, it will automatically unload unused maps to
  57 allow continued operation.
  58
  59 To allow processing large files even on 32 bit systems, it allows only
  60 portions of the file to be mapped. Once the user reads beyond the mapped
  61 region, smmap will automatically map the next required region, unloading
  62 unused regions using a LRU algorithm.
  63
  64 Although the library can be used most efficiently with its native
  65 interface, a Buffer implementation is provided to hide these details behind
  66 a simple string-like interface.
  67
  68 For performance critical 64 bit applications, a simplified version of
  69 memory mapping is provided which always maps the whole file, but still
  70 provides the benefit of unloading unused mappings on demand.
  71
  72 ## Prerequisites
  73
  74 * Python 3.6+
  75 * OSX, Windows or Linux
  76
  77 The package was tested on all of the previously mentioned configurations.
  78
  79 ## Installing smmap
  80
  81 [Documentation Status]
  82
  83 Its easiest to install smmap using the [pip] program:
  84
  85 ```bash
  86 $ pip install smmap
  87 ```
  88
  89 As the command will install smmap in your respective python distribution,
  90 you will most likely need root permissions to authorize the required
  91 changes.
  92
  93 If you have downloaded the source archive, the package can be installed by
  94 running the `setup.py` script:
  95
  96 ```bash
  97 $ python setup.py install
  98 ```
  99
 100 It is advised to have a look at the **Usage Guide** for a brief
 101 introduction on the different database implementations.
 102
 103 ## Homepage and Links
 104
 105 The project is home on github at
 106 https://github.com/gitpython-developers/smmap .
 107
 108 The latest source can be cloned from github as well:
 109
 110 * git://github.com/gitpython-developers/smmap.git
 111
 112 For support, please use the git-python mailing list:
 113
 114 * http://groups.google.com/group/git-python
 115
 116 Issues can be filed on github:
 117
 118 * https://github.com/gitpython-developers/smmap/issues
 119
 120 A link to the pypi page related to this repository:
 121
 122 * https://pypi.org/project/smmap/
 123
 124 ## License Information
 125
 126 *smmap* is licensed under the New BSD License.
 127
 128
 129 [FILE:107:distinfo]
 130 2aba19d6a040e78d8b09de5c57e96207b09ed71d8e55ce0959eeee6c8e190d94        24271 smmap-5.0.0-py3-none-any.whl
 131