cartorio

A wrapper on the logging module for Python that provides a simple and easy to use interface for logging.

https://github.com/hsteinshiromoto/cartorio

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.5%) to scientific vocabulary

Keywords

log logger logging python
Last synced: 6 months ago · JSON representation ·

Repository

A wrapper on the logging module for Python that provides a simple and easy to use interface for logging.

Basic Info
  • Host: GitHub
  • Owner: hsteinshiromoto
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 3.03 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 12
Topics
log logger logging python
Created over 5 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

DOI Documentation Status GitHub tag (latest SemVer) LICENSE

1. Cartorio

A wrapper on the logging module for Python that provides a simple and easy-to-use interface for logging.

2. Contents

3. Installation

bash pip install cartorio

4. Documentation

https://cartorio.readthedocs.io/en/stable/

5. Usage

Consider that your project consists of two scripts:

bash parent.py child/ └── child.py

An example of these scripts are: ```python

parent.py

from pathlib import Path from cartorio import make_logger, log

from child.child import multiply

@log def main() multiply(10, 1)

if name == "main": # Instantiation of log file logger, _ = makelogger(filename=Path(file).resolve().stem, logspath=Path(file).resolve().parent) # where, # filename (str, Path): Log file. # logs_path (Path): Path where the log file is saved to. main() ```

```python

child.py

from cartorio import fun, log

@log def multiply(num1, num2): return num1 * num2 ```

The log filename will be parent_<timestamp>.log and it will contain the information in the form <timestamp> || root || 30664 || INFO || parent.py || parent || <line_number> || Enter || multiply <timestamp> || root || 30664 || INFO || parent.py || parent || <line_number> || Leave || multiply || Elapsed: 0:00:00.001708

Owner

  • Name: Humberto STEIN SHIROMOTO
  • Login: hsteinshiromoto
  • Kind: user
  • Location: Sydney, Australia

Cybernetician

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: STEIN SHIROMOTO
    given-names: Humberto
    orcid: https://orcid.org/0000-0002-0883-0231
title: "Cartorio: A library for logging"
version: 3.0.0
doi: 10.5281/zenodo.5563175
date-released: 2022-11-29

GitHub Events

Total
Last Year

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 197
  • Total Committers: 1
  • Avg Commits per committer: 197.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Humberto STEIN SHIROMOTO h****o@g****m 197

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
dependencies (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 94 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 2
  • Total versions: 20
  • Total maintainers: 1
pypi.org: cartorio

Cartorio: A library for logging

  • Versions: 20
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 94 Last month
Rankings
Dependent packages count: 10.0%
Dependent repos count: 11.6%
Average: 22.8%
Downloads: 23.9%
Forks count: 29.8%
Stargazers count: 38.8%
Maintainers (1)
Last synced: 7 months ago

Dependencies

.github/workflows/build-pipy.yml actions
  • actions/checkout v2 composite
  • actions/download-artifact v2 composite
  • actions/upload-artifact v2 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/new_release.yml actions
  • actions/checkout v2.2.0 composite
  • actions/create-release v1 composite
.github/workflows/test_code.yml actions
  • actions/checkout v2 composite
.github/workflows/test_pip_code.yml actions
  • actions/checkout v2 composite
Dockerfile docker
  • $DOCKER_PARENT_IMAGE latest build
requirements.txt pypi
  • myst-parser *
  • pytest *
  • sphinx *
  • sphinx_rtd_theme *
setup.py pypi