funcprofiler 1.0.0__tar.gz → 1.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- funcprofiler-1.0.1/PKG-INFO +106 -0
- funcprofiler-1.0.1/funcprofiler.egg-info/PKG-INFO +106 -0
- {funcprofiler-1.0.0 → funcprofiler-1.0.1}/setup.py +6 -3
- funcprofiler-1.0.0/PKG-INFO +0 -22
- funcprofiler-1.0.0/funcprofiler.egg-info/PKG-INFO +0 -22
- {funcprofiler-1.0.0 → funcprofiler-1.0.1}/LICENSE +0 -0
- {funcprofiler-1.0.0 → funcprofiler-1.0.1}/README.md +0 -0
- {funcprofiler-1.0.0 → funcprofiler-1.0.1}/funcprofiler/__init__.py +0 -0
- {funcprofiler-1.0.0 → funcprofiler-1.0.1}/funcprofiler.egg-info/SOURCES.txt +0 -0
- {funcprofiler-1.0.0 → funcprofiler-1.0.1}/funcprofiler.egg-info/dependency_links.txt +0 -0
- {funcprofiler-1.0.0 → funcprofiler-1.0.1}/funcprofiler.egg-info/top_level.txt +0 -0
- {funcprofiler-1.0.0 → funcprofiler-1.0.1}/setup.cfg +0 -0
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: funcprofiler
|
|
3
|
+
Version: 1.0.1
|
|
4
|
+
Summary: An open-source Python library for finding bottlenecks in code. Includes function profiling, data exports, logging, and even line-by-line profiling, for more control.
|
|
5
|
+
Home-page: https://github.com/infinitode/valx
|
|
6
|
+
Author: Infinitode Pty Ltd
|
|
7
|
+
Author-email: infinitode.ltd@gmail.com
|
|
8
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
9
|
+
Classifier: Intended Audience :: Developers
|
|
10
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.6
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Requires-Python: >=3.6
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
|
|
22
|
+
# FuncProfiler
|
|
23
|
+

|
|
24
|
+
[](https://github.com/infinitode/funcprofiler)
|
|
25
|
+

|
|
26
|
+

|
|
27
|
+

|
|
28
|
+
|
|
29
|
+
An open-source Python library for identifying bottlenecks in code. It includes function profiling, data exports, logging, and line-by-line profiling for more granular control.
|
|
30
|
+
|
|
31
|
+
## Installation
|
|
32
|
+
|
|
33
|
+
You can install FuncProfiler using pip:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
pip install funcprofiler
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Supported Python Versions
|
|
40
|
+
|
|
41
|
+
FuncProfiler supports the following Python versions:
|
|
42
|
+
|
|
43
|
+
- Python 3.6
|
|
44
|
+
- Python 3.7
|
|
45
|
+
- Python 3.8
|
|
46
|
+
- Python 3.9
|
|
47
|
+
- Python 3.10
|
|
48
|
+
- Python 3.11 and later (preferred)
|
|
49
|
+
|
|
50
|
+
Please ensure that you have one of these Python versions installed. FuncProfiler may not function as expected on earlier versions.
|
|
51
|
+
|
|
52
|
+
## Features
|
|
53
|
+
|
|
54
|
+
- **Function Profiling**: Monitor a function's memory usage and execution time to identify performance issues.
|
|
55
|
+
- **Line-by-Line Profiling**: Return execution time and memory usage for each line of any given function.
|
|
56
|
+
- **Shared Logging**: Log outputs of functions triggered by the line-by-line and function profilers, storing results in a `.txt` file.
|
|
57
|
+
- **File Exports**: Export profiling data from functions in `csv`, `json`, or `html` formats.
|
|
58
|
+
> [!NOTE]
|
|
59
|
+
> View more export types in the [official documentation](https://infinitode-docs.gitbook.io/documentation/package-documentation/funcprofiler-package-documentation).
|
|
60
|
+
|
|
61
|
+
## Usage
|
|
62
|
+
|
|
63
|
+
### Function Profiling
|
|
64
|
+
|
|
65
|
+
```python
|
|
66
|
+
from funcprofiler import function_profile
|
|
67
|
+
|
|
68
|
+
# Exporting as `html` with logging enabled
|
|
69
|
+
@function_profile(export_format="html", shared_log=True)
|
|
70
|
+
def some_function():
|
|
71
|
+
return "Hello World."
|
|
72
|
+
|
|
73
|
+
# Call the function
|
|
74
|
+
message = some_function()
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Line-by-Line Profiling
|
|
78
|
+
|
|
79
|
+
```python
|
|
80
|
+
from funcprofiler import line_by_line_profile
|
|
81
|
+
|
|
82
|
+
# Logging enabled without exports
|
|
83
|
+
@line_by_line_profile(shared_log=True)
|
|
84
|
+
def some_complicated_function(n):
|
|
85
|
+
total = 0
|
|
86
|
+
for i in range(n):
|
|
87
|
+
for j in range(i):
|
|
88
|
+
total += (i * j) ** 0.5 # Square root calculation
|
|
89
|
+
return total
|
|
90
|
+
|
|
91
|
+
# Call the function
|
|
92
|
+
total = some_complicated_function(1000)
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
> [!NOTE]
|
|
96
|
+
> FuncProfiler can be added to any function using the callable format: `@funcprofiler_function_name(expected_arguments)`.
|
|
97
|
+
|
|
98
|
+
## Contributing
|
|
99
|
+
|
|
100
|
+
Contributions are welcome! If you encounter issues, have suggestions, or wish to contribute to FuncProfiler, please open an issue or submit a pull request on [GitHub](https://github.com/infinitode/funcprofiler).
|
|
101
|
+
|
|
102
|
+
## License
|
|
103
|
+
|
|
104
|
+
FuncProfiler is released under the terms of the **MIT License (Modified)**. Please see the [LICENSE](https://github.com/infinitode/funcprofiler/blob/main/LICENSE) file for the full text.
|
|
105
|
+
|
|
106
|
+
**Modified License Clause**: The modified license clause allows users to create derivative works based on the FuncProfiler software. However, it requires that any substantial changes to the software be clearly distinguished from the original work and distributed under a different name.
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: funcprofiler
|
|
3
|
+
Version: 1.0.1
|
|
4
|
+
Summary: An open-source Python library for finding bottlenecks in code. Includes function profiling, data exports, logging, and even line-by-line profiling, for more control.
|
|
5
|
+
Home-page: https://github.com/infinitode/valx
|
|
6
|
+
Author: Infinitode Pty Ltd
|
|
7
|
+
Author-email: infinitode.ltd@gmail.com
|
|
8
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
9
|
+
Classifier: Intended Audience :: Developers
|
|
10
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.6
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Requires-Python: >=3.6
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
|
|
22
|
+
# FuncProfiler
|
|
23
|
+

|
|
24
|
+
[](https://github.com/infinitode/funcprofiler)
|
|
25
|
+

|
|
26
|
+

|
|
27
|
+

|
|
28
|
+
|
|
29
|
+
An open-source Python library for identifying bottlenecks in code. It includes function profiling, data exports, logging, and line-by-line profiling for more granular control.
|
|
30
|
+
|
|
31
|
+
## Installation
|
|
32
|
+
|
|
33
|
+
You can install FuncProfiler using pip:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
pip install funcprofiler
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Supported Python Versions
|
|
40
|
+
|
|
41
|
+
FuncProfiler supports the following Python versions:
|
|
42
|
+
|
|
43
|
+
- Python 3.6
|
|
44
|
+
- Python 3.7
|
|
45
|
+
- Python 3.8
|
|
46
|
+
- Python 3.9
|
|
47
|
+
- Python 3.10
|
|
48
|
+
- Python 3.11 and later (preferred)
|
|
49
|
+
|
|
50
|
+
Please ensure that you have one of these Python versions installed. FuncProfiler may not function as expected on earlier versions.
|
|
51
|
+
|
|
52
|
+
## Features
|
|
53
|
+
|
|
54
|
+
- **Function Profiling**: Monitor a function's memory usage and execution time to identify performance issues.
|
|
55
|
+
- **Line-by-Line Profiling**: Return execution time and memory usage for each line of any given function.
|
|
56
|
+
- **Shared Logging**: Log outputs of functions triggered by the line-by-line and function profilers, storing results in a `.txt` file.
|
|
57
|
+
- **File Exports**: Export profiling data from functions in `csv`, `json`, or `html` formats.
|
|
58
|
+
> [!NOTE]
|
|
59
|
+
> View more export types in the [official documentation](https://infinitode-docs.gitbook.io/documentation/package-documentation/funcprofiler-package-documentation).
|
|
60
|
+
|
|
61
|
+
## Usage
|
|
62
|
+
|
|
63
|
+
### Function Profiling
|
|
64
|
+
|
|
65
|
+
```python
|
|
66
|
+
from funcprofiler import function_profile
|
|
67
|
+
|
|
68
|
+
# Exporting as `html` with logging enabled
|
|
69
|
+
@function_profile(export_format="html", shared_log=True)
|
|
70
|
+
def some_function():
|
|
71
|
+
return "Hello World."
|
|
72
|
+
|
|
73
|
+
# Call the function
|
|
74
|
+
message = some_function()
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Line-by-Line Profiling
|
|
78
|
+
|
|
79
|
+
```python
|
|
80
|
+
from funcprofiler import line_by_line_profile
|
|
81
|
+
|
|
82
|
+
# Logging enabled without exports
|
|
83
|
+
@line_by_line_profile(shared_log=True)
|
|
84
|
+
def some_complicated_function(n):
|
|
85
|
+
total = 0
|
|
86
|
+
for i in range(n):
|
|
87
|
+
for j in range(i):
|
|
88
|
+
total += (i * j) ** 0.5 # Square root calculation
|
|
89
|
+
return total
|
|
90
|
+
|
|
91
|
+
# Call the function
|
|
92
|
+
total = some_complicated_function(1000)
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
> [!NOTE]
|
|
96
|
+
> FuncProfiler can be added to any function using the callable format: `@funcprofiler_function_name(expected_arguments)`.
|
|
97
|
+
|
|
98
|
+
## Contributing
|
|
99
|
+
|
|
100
|
+
Contributions are welcome! If you encounter issues, have suggestions, or wish to contribute to FuncProfiler, please open an issue or submit a pull request on [GitHub](https://github.com/infinitode/funcprofiler).
|
|
101
|
+
|
|
102
|
+
## License
|
|
103
|
+
|
|
104
|
+
FuncProfiler is released under the terms of the **MIT License (Modified)**. Please see the [LICENSE](https://github.com/infinitode/funcprofiler/blob/main/LICENSE) file for the full text.
|
|
105
|
+
|
|
106
|
+
**Modified License Clause**: The modified license clause allows users to create derivative works based on the FuncProfiler software. However, it requires that any substantial changes to the software be clearly distinguished from the original work and distributed under a different name.
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
from setuptools import setup, find_packages
|
|
2
2
|
|
|
3
|
+
with open("README.md", "r", encoding="utf-8") as fh:
|
|
4
|
+
long_description = fh.read()
|
|
5
|
+
|
|
3
6
|
setup(
|
|
4
7
|
name='funcprofiler',
|
|
5
|
-
version='1.0.
|
|
8
|
+
version='1.0.1',
|
|
6
9
|
author='Infinitode Pty Ltd',
|
|
7
10
|
author_email='infinitode.ltd@gmail.com',
|
|
8
|
-
description='An open-source Python library
|
|
9
|
-
long_description=
|
|
11
|
+
description='An open-source Python library for finding bottlenecks in code. Includes function profiling, data exports, logging, and even line-by-line profiling, for more control.',
|
|
12
|
+
long_description=long_description,
|
|
10
13
|
long_description_content_type='text/markdown',
|
|
11
14
|
url='https://github.com/infinitode/valx',
|
|
12
15
|
packages=find_packages(),
|
funcprofiler-1.0.0/PKG-INFO
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: funcprofiler
|
|
3
|
-
Version: 1.0.0
|
|
4
|
-
Summary: An open-source Python library that can be used to profile functions.
|
|
5
|
-
Home-page: https://github.com/infinitode/valx
|
|
6
|
-
Author: Infinitode Pty Ltd
|
|
7
|
-
Author-email: infinitode.ltd@gmail.com
|
|
8
|
-
Classifier: Development Status :: 5 - Production/Stable
|
|
9
|
-
Classifier: Intended Audience :: Developers
|
|
10
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
11
|
-
Classifier: Programming Language :: Python :: 3.6
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.7
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
-
Requires-Python: >=3.6
|
|
19
|
-
Description-Content-Type: text/markdown
|
|
20
|
-
License-File: LICENSE
|
|
21
|
-
|
|
22
|
-
An open-source Python library for finding bottlenecks in code. Includes function profiling, data exports, logging, and even line-by-line profiling, for more control.
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: funcprofiler
|
|
3
|
-
Version: 1.0.0
|
|
4
|
-
Summary: An open-source Python library that can be used to profile functions.
|
|
5
|
-
Home-page: https://github.com/infinitode/valx
|
|
6
|
-
Author: Infinitode Pty Ltd
|
|
7
|
-
Author-email: infinitode.ltd@gmail.com
|
|
8
|
-
Classifier: Development Status :: 5 - Production/Stable
|
|
9
|
-
Classifier: Intended Audience :: Developers
|
|
10
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
11
|
-
Classifier: Programming Language :: Python :: 3.6
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.7
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
-
Requires-Python: >=3.6
|
|
19
|
-
Description-Content-Type: text/markdown
|
|
20
|
-
License-File: LICENSE
|
|
21
|
-
|
|
22
|
-
An open-source Python library for finding bottlenecks in code. Includes function profiling, data exports, logging, and even line-by-line profiling, for more control.
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|