Metadata-Version: 2.4
Name: dStats
Version: 1.0.4
Summary: A real-time web-based monitoring tool that provides performance stats for Docker containers and visualizes their network connectivity graph
Author-email: Abdullah Al Arif <arifcse21@gmail.com>
License: MIT License
Project-URL: Homepage, https://github.com/Arifcse21/dStats
Project-URL: Repository, https://github.com/Arifcse21/dStats
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.12.3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Django>=5.1.5
Requires-Dist: graphviz>=0.20.3
Requires-Dist: docker>=7.1.0
Requires-Dist: daphne>=4.1.2
Requires-Dist: requests>=2.32.3
Requires-Dist: black>=24.10.0
Requires-Dist: python-decouple>=3.6
Provides-Extra: dev
Requires-Dist: uv>=0.2; extra == "dev"
Requires-Dist: twine>=4.0; extra == "dev"
Dynamic: license-file


# **dStats**

**dStats** is a real-time web-based monitoring tool that provides performance stats for Docker containers and visualizes their network connectivity graph.

---
## Run the Python pip package
```bash
pip install dStats
```

## Run the server:
```bash
dStats.server
```

## With Basic Authentication(Good for security)
```bash
USE_AUTH=true AUTH_USERNAME=<your_username> AUTH_PASSWORD=<your_password> dStats.server
```
## **Access the Application(Running on port 2743)**
- Open your browser and go to:  
  **http://localhost:2743**

---
## Example UI
![Alt docker stats and network graph](https://github.com/Arifcse21/dStats/blob/main/examples/stats-and-network-graph.png)
![Alt docker network graph](https://github.com/Arifcse21/dStats/blob/main/examples/network-visualizer-graph.png)
![Alt docker network graph](https://github.com/Arifcse21/dStats/blob/main/examples/stats-chart.png)

Here, you’ll find:
1. **Container Stats:** Real-time CPU, memory, and network I/O usage.
2. **Network Graph:** Visualization of container interconnections.

---
Note: To run continuously you can create a systemd service or use the [docker image](https://hub.docker.com/r/arifcse21/dstats)

---
## **Contribute to dStats Project**

Thank you for considering contributing to dStats! We appreciate all efforts, big or small, to help improve the [project](https://github.com/Arifcse21/dStats)
