Skip to main content

A utility module to track and limit the number of running application instances by checking processes and lock files.

Project description

🚀 Instance Checker

A simple and powerful Python utility to count running instances of an application by checking both:

  • Running processes (via psutil)
  • Lock files in a specified directory

Perfect for preventing multiple concurrent runs of the same app.


📦 Features

✅ Count processes by command line
✅ Count lock files with .lock. pattern
✅ Works on Unix and Windows
✅ Easy to integrate into your project
✅ 100% Pythonic 😍


🧰 Installation

pip install instance-checker

⚠️ This package requires Python 3.9+


🧪 Usage Example

from instance_checker.utils import CountHelper

helper = CountHelper(lock_dir="/tmp/my_app_locks")

print(helper.process_count("my_app"))        #> 2
print(helper.pid_file_count("my_app"))       #> 1

🛠 How It Works

Process Checking ✅

Counts how many running processes have a given identifier in their command-line arguments.

CountHelper.process_count("my_app")

Lock File Checking 🔐

Counts how many .lock. files exist in the specified directory that contain the identifier.

helper.pid_file_count("my_app")

🧹 Why You Should Use This

  • Prevents race conditions when running apps concurrently
  • Lightweight and easy to integrate
  • No need to write boilerplate process/lock management code
  • Safe and reliable thanks to psutil and pathlib

🧾 License

This project is licensed under the MIT License - see the LICENSE file for details.


🧑‍💻 Made with ❤️ by @dkurchigin

If you like this tool, give it a star ⭐ — it really helps! And if you're building cool stuff with it, let me know — I'd love to see it! 💻✨

🐙 GITVERSE

🔗 https://gitverse.ru/dkurchigin/instance_checker

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

instance_checker-0.4.2.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

instance_checker-0.4.2-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file instance_checker-0.4.2.tar.gz.

File metadata

  • Download URL: instance_checker-0.4.2.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.25.9 CPython/3.13.5 Linux/6.14.0-29-generic

File hashes

Hashes for instance_checker-0.4.2.tar.gz
Algorithm Hash digest
SHA256 0f0aefec3e6eaed99ff937a568b55d7664daefa67f6ed055a3b9a208b6a1a03d
MD5 0ac1bff279a08db35668b351af063f0a
BLAKE2b-256 bb0cec30a1289058d088d0000be84b8ff8ba813f425c6550e8c20bd6b54b15cb

See more details on using hashes here.

File details

Details for the file instance_checker-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: instance_checker-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.25.9 CPython/3.13.5 Linux/6.14.0-29-generic

File hashes

Hashes for instance_checker-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7a76f74fb0ba4895ebb4dc704e26c067ea3b05f4cc8b911dc03199bdded0ab14
MD5 55ec145ec2afc186dc592e443e5513c5
BLAKE2b-256 104cc4636e02772847c198bdcba6f54528a8d2997b85da8d98fecc85aa0ecb4d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page