├── .github └── FUNDING.yml ├── .gitignore ├── LICENSE ├── MANIFEST ├── README.md ├── doc └── hazelnut.png ├── hazelnut ├── __init__.py └── core.py └── setup.py /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: [barnumbirr] 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | *.pyc 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2014-2017 Martin Simon 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /MANIFEST: -------------------------------------------------------------------------------- 1 | LICENSE 2 | setup.py 3 | README.md 4 | hazelnut/core.py 5 | hazelnut/__init__.py 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

hazelnut hazelnut

2 | 3 | [![PyPi Version](http://img.shields.io/pypi/v/hazelnut.svg)](https://pypi.python.org/pypi/hazelnut/) 4 | 5 | 6 | **hazelnut** is an APACHE licensed library written in Python designed to provide a simple and pythonic way to parse the _/proc/meminfo_ file on LINUX based systems. 7 | This library has been tested with Python 2.7.x and Python 3.6.x. 8 | 9 | 10 | ## Installation: 11 | 12 | From source use 13 | 14 | $ python setup.py install 15 | 16 | or install from PyPi 17 | 18 | $ pip install hazelnut 19 | 20 | ## Documentation: 21 | 22 | - Basic use: 23 | 24 | ```python 25 | >>> from hazelnut import MemInfo 26 | >>> mem = MemInfo() 27 | >>> mem 28 | MemTotal: 8092460 kB 29 | MemFree: 499880 kB 30 | MemAvailable: 5454920 kB 31 | Buffers: 219088 kB 32 | Cached: 4980040 kB 33 | SwapCached: 7576 kB 34 | Active: 5647392 kB 35 | Inactive: 1628708 kB 36 | Active(anon): 1794356 kB 37 | Inactive(anon): 492656 kB 38 | Active(file): 3853036 kB 39 | Inactive(file): 1136052 kB 40 | Unevictable: 200 kB 41 | Mlocked: 200 kB 42 | SwapTotal: 16776188 kB 43 | SwapFree: 16639112 kB 44 | Dirty: 172 kB 45 | Writeback: 0 kB 46 | AnonPages: 2070440 kB 47 | Mapped: 204800 kB 48 | Shmem: 210036 kB 49 | Slab: 247884 kB 50 | SReclaimable: 219356 kB 51 | SUnreclaim: 28528 kB 52 | KernelStack: 4144 kB 53 | PageTables: 11904 kB 54 | NFS_Unstable: 0 kB 55 | Bounce: 0 kB 56 | WritebackTmp: 0 kB 57 | CommitLimit: 20822416 kB 58 | Committed_AS: 3317504 kB 59 | VmallocTotal: 34359738367 kB 60 | VmallocUsed: 362844 kB 61 | VmallocChunk: 34359347296 kB 62 | HardwareCorrupted: 0 kB 63 | AnonHugePages: 0 kB 64 | HugePages_Total: 0 65 | HugePages_Free: 0 66 | HugePages_Rsvd: 0 67 | HugePages_Surp: 0 68 | Hugepagesize: 2048 kB 69 | DirectMap4k: 83644 kB 70 | DirectMap2M: 8202240 kB 71 | ``` 72 | 73 | - Return output as dict: 74 | 75 | ```python 76 | >>> mem.dict() 77 | { 78 | "WritebackTmp": "0 kB", 79 | "SwapTotal": "16776188 kB", 80 | "Active(anon)": "1794356 kB", 81 | "SwapFree": "16639112 kB", 82 | "DirectMap4k": "83644 kB", 83 | "KernelStack": "4144 kB", 84 | "MemFree": "499880 kB", 85 | "HugePages_Rsvd": "0", 86 | "Committed_AS": "3317504 kB", 87 | "SUnreclaim": "28528 kB", 88 | "NFS_Unstable": "0 kB", 89 | "VmallocChunk": "34359347296 kB", 90 | "Writeback": "0 kB", 91 | "Inactive(file)": "1136052 kB", 92 | "MemTotal": "8092460 kB", 93 | "VmallocUsed": "362844 kB", 94 | "HugePages_Free": "0", 95 | "AnonHugePages": "0 kB", 96 | "Shmem": "210036 kB", 97 | "AnonPages": "2070440 kB", 98 | "Active": "5647392 kB", 99 | "Inactive(anon)": "492656 kB", 100 | "HugePages_Total": "0", 101 | "Hugepagesize": "2048 kB", 102 | "Cached": "4980040 kB", 103 | "SwapCached": "7576 kB", 104 | "VmallocTotal": "34359738367 kB", 105 | "Dirty": "172 kB", 106 | "Mapped": "204800 kB", 107 | "Unevictable": "200 kB", 108 | "SReclaimable": "219356 kB", 109 | "MemAvailable": "5454920 kB", 110 | "Slab": "247884 kB", 111 | "DirectMap2M": "8202240 kB", 112 | "HugePages_Surp": "0", 113 | "Bounce": "0 kB", 114 | "Inactive": "1628708 kB", 115 | "PageTables": "11904 kB", 116 | "HardwareCorrupted": "0 kB", 117 | "CommitLimit": "20822416 kB", 118 | "Mlocked": "200 kB", 119 | "Buffers": "219088 kB", 120 | "Active(file)": "3853036 kB" 121 | } 122 | ``` 123 | 124 | - Search (is case insensitive): 125 | 126 | ```python 127 | >>> mem.search('Swap') 128 | ['SwapCached: 7576 kB\n', 'SwapTotal: 16776188 kB\n', 'SwapFree: 16639112 kB\n'] 129 | ``` 130 | 131 | - Get memory usage as int (is case sensitive): 132 | 133 | ```python 134 | >>> mem.get('Inactive(anon)') 135 | 492656 136 | ``` 137 | 138 | ## License: 139 | 140 | ``` 141 | Copyright 2014-2017 Martin Simon 142 | 143 | Licensed under the Apache License, Version 2.0 (the "License"); 144 | you may not use this file except in compliance with the License. 145 | You may obtain a copy of the License at 146 | 147 | http://www.apache.org/licenses/LICENSE-2.0 148 | 149 | Unless required by applicable law or agreed to in writing, software 150 | distributed under the License is distributed on an "AS IS" BASIS, 151 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 152 | See the License for the specific language governing permissions and 153 | limitations under the License. 154 | 155 | ``` 156 | 157 | ## Buy me a coffee? 158 | 159 | If you feel like buying me a coffee (or a beer?), donations are welcome: 160 | 161 | ``` 162 | WDC : WbcWJzVD8yXt3yLnnkCZtwQo4YgSUdELkj 163 | HBN : F2Zs4igv8r4oJJzh4sh4bGmeqoUxLQHPki 164 | DOGE: DRBkryyau5CMxpBzVmrBAjK6dVdMZSBsuS 165 | ``` 166 | -------------------------------------------------------------------------------- /doc/hazelnut.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/barnumbirr/hazelnut/bf22120e8fd1c09228dc8570c7d5d45c60ac3b0f/doc/hazelnut.png -------------------------------------------------------------------------------- /hazelnut/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | __title__ = 'hazelnut' 5 | __version__ = '0.4.1' 6 | __author__ = 'Martin Simon ' 7 | __repo__ = 'https://github.com/mrsmn/hazelnut' 8 | __license__ = 'Apache v2.0 License' 9 | 10 | from .core import MemInfo 11 | -------------------------------------------------------------------------------- /hazelnut/core.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | import re 5 | 6 | class MemInfo(object): 7 | 8 | def __init__(self, path='/proc/meminfo'): 9 | self.path = path 10 | 11 | def fileobj(self): 12 | return open(self.path, 'r') 13 | 14 | def __str__(self): 15 | with self.fileobj() as f: 16 | lines = [line.strip() for line in f] 17 | return '\n'.join(lines) 18 | 19 | def __repr__(self): 20 | return self.__str__() 21 | 22 | def dict(self): 23 | with self.fileobj() as f: 24 | d = dict(x.strip().split(None, 1) for x in f) 25 | d = {key.strip(':'): item.strip() for key, item in d.items()} 26 | return d 27 | 28 | def search(self, regex): 29 | with self.fileobj() as f: 30 | matcher = re.compile(regex, re.IGNORECASE) 31 | return [k for k in f if matcher.match(k)] 32 | 33 | def get(self, string): 34 | with self.fileobj() as f: 35 | for item in f: 36 | line = item.strip() 37 | if line.startswith(string): 38 | match = re.findall(r'([0-9]+)\s', line) 39 | return int(match[0]) 40 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | from distutils.core import setup 5 | 6 | setup( 7 | name='hazelnut', 8 | version='0.4.1', 9 | url='https://github.com/mrsmn/hazelnut', 10 | download_url='https://github.com/mrsmn/hazelnut/archive/master.zip', 11 | author='Martin Simon', 12 | author_email='me@martinsimon.me', 13 | license='Apache v2.0 License', 14 | packages=['hazelnut'], 15 | description='A pythonic library to parse /proc/meminfo', 16 | long_description = open('README.md','r').read(), 17 | keywords=['memory', 'RAM', 'system information', 'meminfo', '/proc'], 18 | ) 19 | --------------------------------------------------------------------------------