-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Made the package ready for release on pypi
- Loading branch information
1 parent
1eb7ec1
commit 26aa49c
Showing
3 changed files
with
60 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
log_call | ||
======== | ||
|
||
library to log function or bond-method calls | ||
|
||
Installation | ||
============ | ||
|
||
:: | ||
|
||
for stable version | ||
- pip install log_call | ||
|
||
for developement | ||
- git clone https://github.com/Agent-Hellboy/log_call | ||
- cd log_call | ||
- python -m venv .venv | ||
- source .venv/bin/activate | ||
|
||
Example | ||
------- | ||
|
||
Import log_call from log_call and decorate your class or function with | ||
it | ||
|
||
.. code:: py | ||
from log_call import log_call | ||
@log_call | ||
class A: | ||
def __init__(self): | ||
pass | ||
def a(self,*args,**kwargs): | ||
pass | ||
a=A() | ||
a.a(45,'str',s=34,g=43) | ||
@log_call | ||
def c(a,*args,**kwargs): | ||
pass | ||
c(34,56,p=23) | ||
:: | ||
|
||
response | ||
2022-09-04 12:56:08,552 a called with {'args': [45, 'str'], 'kwargs': {'s': 34, 'g': 43}} | ||
2022-09-04 12:56:08,552 c called with {'a': 34, 'args': [56], 'kwargs': {'p': 23}} | ||
|
||
Contributing | ||
============ | ||
|
||
Pull requests are welcome. For major changes, please open an issue first | ||
to discuss what you would like to change. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,7 +14,7 @@ def read(fname): | |
author_email="[email protected]", | ||
url="https://github.com/Agent-Hellboy/log_call", | ||
description=("Library to log function or bond-method calls"), | ||
long_description=read("README.md"), | ||
long_description=read("README.rst"), | ||
license="MIT", | ||
package_dir={'': 'src'}, | ||
packages=['log_call'], | ||
|