Metadata-Version: 2.4
Name: daemonpy
Version: 2.0.7
Summary: Creating Daemon process
Home-page: https://vroncevic.github.io/daemonpy/
Author: Vladimir Roncevic
Author-email: elektron.ronca@gmail.com
License: GPL-3.0-or-later
Keywords: Unix,Linux,Daemon,Process
Platform: any
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ats-utilities
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: requires-dist
Dynamic: summary

# Creating Daemon process

<img align="right" src="https://raw.githubusercontent.com/vroncevic/daemonpy/dev/docs/daemonpy_logo.png" width="25%">

**daemonpy** is package for creating Daemon processes.

Developed in **[python](https://www.python.org/)** code: **100%**.

The README is used to introduce the modules and provide instructions on
how to install the modules, any machine dependencies it may have and any
other information that should be provided before the modules are installed.

[![daemonpy python checker](https://github.com/vroncevic/daemonpy/actions/workflows/daemonpy_python_checker.yml/badge.svg)](https://github.com/vroncevic/daemonpy/actions/workflows/daemonpy_python_checker.yml) [![daemonpy package checker](https://github.com/vroncevic/daemonpy/actions/workflows/daemonpy_package_checker.yml/badge.svg)](https://github.com/vroncevic/daemonpy/actions/workflows/daemonpy_package.yml) [![GitHub issues open](https://img.shields.io/github/issues/vroncevic/daemonpy.svg)](https://github.com/vroncevic/daemonpy/issues) [![GitHub contributors](https://img.shields.io/github/contributors/vroncevic/daemonpy.svg)](https://github.com/vroncevic/daemonpy/graphs/contributors)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Installation](#installation)
    - [Install using pip](#install-using-pip)
    - [Install using build](#install-using-build)
    - [Install using py setup](#install-using-py-setup)
    - [Install using docker](#install-using-docker)
- [Usage](#usage)
- [Dependencies](#dependencies)
- [Package structure](#package-structure)
- [Code coverage](#code-coverage)
- [Docs](#docs)
- [Copyright and Licence](#copyright-and-licence)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

### Installation

Used next development environment

![debian linux os](https://raw.githubusercontent.com/vroncevic/daemonpy/dev/docs/debtux.png)

[![daemonpy python3 build](https://github.com/vroncevic/daemonpy/actions/workflows/daemonpy_python3_build.yml/badge.svg)](https://github.com/vroncevic/daemonpy/actions/workflows/daemonpy_python3_build.yml)

Currently there are three ways to install package
* Install process based on using pip mechanism
* Install process based on build mechanism
* Install process based on setup.py mechanism
* Install process based on docker mechanism

##### Install using pip

Python package is located at **[pypi.org](https://pypi.org/project/daemonpy/)**.

You can install by using pip

```bash
# python3
pip3 install daemonpy
```

##### Install using build

Navigate to **[release page](https://github.com/vroncevic/daemonpy/releases)** download and extract release archive.

To install **daemonpy** type the following

```bash
tar xvzf daemonpy-x.y.z.tar.gz
cd daemonpy-x.y.z
# python3
pip3 install -r requirements.txt
python3 -m build
pip3 install dist/daemonpy-x.y.z-py3-none-any.whl
```

##### Install using py setup

Navigate to **[release page](https://github.com/vroncevic/daemonpy/releases)** download and extract release archive.

To install **daemonpy**, locate and run setup.py with arguments

```bash
tar xvzf daemonpy-x.y.z.tar.gz
cd daemonpy-x.y.z
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
```

##### Install using docker

You can use Dockerfile to create image/container.

### Usage

Create short example

```python
#!/usr/bin/env python

'''
 Module
     mydaemon.py
 Copyright
     Copyright (C) 2020 - 2026 Vladimir Roncevic <elektron.ronca@gmail.com>
     mydaemon is free software: you can redistribute it and/or modify it
     under the terms of the GNU General Public License as published by the
     Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
     mydaemon is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
     See the GNU General Public License for more details.
     You should have received a copy of the GNU General Public License along
     with this program. If not, see <http://www.gnu.org/licenses/>.
 Info
     Defines class MyDaemon with attribute(s) and method(s).
     Set an operation for Daemon process.
'''

import sys
from time import sleep

try:
    from daemonpy import Daemon
except ImportError as ats_error:
    MESSAGE = '\n{0}\n{1}\n'.format(__file__, ats_error)
    sys.exit(MESSAGE)  # Force close python ATS ##############################


class MyDaemon(Daemon):
    '''
        Defines class MyDaemon with attribute(s) and method(s).
        Set an operation for Daemon process.
        It defines:

            :attributes:
                | None
            :methods:
                | run - run Daemon process (defined method).
    '''

    def run(self):
        '''
            Run Daemon process with time sleep example.

            :exceptions: None
        '''
        while True:
            sleep(1)

if __name__ == '__main__':
    DAEMON = MyDaemon('/tmp/daemon-example.pid')
    DAEMON.usage(sys.argv[1])
```

### Dependencies

These modules requires other modules and libraries
* [daemonpy - Python App/Tool/Script Utilities](https://pypi.org/project/daemonpy/)

### Package structure

**daemonpy** is based on OOP.

Package structure

```bash
    daemonpy/
       ├── daemon_usage.py
       ├── file_descriptor.py
       ├── file_process_id.py
       ├── __init__.py
       ├── py.typed
       └── unix_operations.py
    
    1 directory, 6 files
```

### Code coverage

| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `daemonpy/__init__.py` | 135 | 79 | 41%|
| `daemonpy/daemon_usage.py` | 45 | 2 | 96%|
| `daemonpy/file_descriptor.py` | 47 | 4 | 91%|
| `daemonpy/file_process_id.py` | 39 | 0 | 100%|
| `daemonpy/unix_operations.py` | 72 | 35 | 51%|
| **Total** | 338 | 120 | 64% |

### Docs

[![Documentation Status](https://readthedocs.org/projects/daemonpy/badge/?version=latest)](https://daemonpy.readthedocs.io/en/latest/?badge=latest)

More documentation and info at

* [daemonpy.readthedocs.io](https://daemonpy.readthedocs.io)
* [www.python.org](https://www.python.org/)

### Contributing

[Contributing to daemonpy](CONTRIBUTING.md)

### Copyright and licence

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Copyright (C) 2020 - 2026 by [vroncevic.github.io/daemonpy](https://vroncevic.github.io/daemonpy/)

**daemonpy** is free software; you can redistribute it and/or modify
it under the same terms as Python itself, either Python version 2.x/3.x or,
at your option, any later version of Python 3 you may have available.

Lets help and support PSF.

[![Python Software Foundation](https://raw.githubusercontent.com/vroncevic/daemonpy/dev/docs/psf-logo-alpha.png)](https://www.python.org/psf/)

[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.python.org/psf/donations/)
