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.0.tar.gz (4.9 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.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: instance_checker-0.4.0.tar.gz
  • Upload date:
  • Size: 4.9 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.0.tar.gz
Algorithm Hash digest
SHA256 b1371c4ce1747268478ac24c2909f295f080eb5ce49a37e5c7afca5d86da8a97
MD5 3e287ef7b09dd443383ec9ebda10692a
BLAKE2b-256 7f898650026c96202056db8f2e0d71b785374213f2a1bb80c398d428c12285ec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: instance_checker-0.4.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a71e739091062010dfec570f43d0eaa826dac180719663530cb70ef6f76409f4
MD5 9673fdc01ee7d380fb0e036f2c9af308
BLAKE2b-256 ed655fad1cf3c631990c655ac75a103c704544caabcd8077c1bb48b48d83f716

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