Skip to content

Commit d77c1c6

Browse files
committed
docs: enhance README with pyOpenSci-aligned structure
1 parent 34102d4 commit d77c1c6

1 file changed

Lines changed: 32 additions & 3 deletions

File tree

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,29 @@
4141
</p>
4242
</div>
4343

44-
`pydhis2` is a next-generation Python library for interacting with [DHIS2](https://www.dhis2.org/), the world's largest health information management system. It provides a clean, modern, and efficient API for data extraction, analysis, and management, with a strong emphasis on creating reproducible workflows—a critical need in scientific research and public health analysis, especially in Low and Middle-Income Country (LMIC) contexts.
44+
## 📘 About
45+
46+
`pydhis2` is a next-generation Python library for interacting with [DHIS2](https://www.dhis2.org/), the world's largest health information management system. It provides a clean, modern, and efficient API for data extraction, analysis, and management, with a strong emphasis on creating **reproducible scientific workflows**—a critical need in public health research and data analysis, especially in Low and Middle-Income Country (LMIC) contexts.
47+
48+
**Target Audience:**
49+
- Public health researchers and data scientists
50+
- DHIS2 implementers and administrators
51+
- Data analysts working with health information systems
52+
- Academic researchers requiring reproducible data pipelines
53+
54+
**Scientific Use Cases:**
55+
- Epidemiological surveillance and analysis
56+
- Health system performance monitoring
57+
- Data quality assessments and validation
58+
- Routine health data analytics
59+
- Integration with statistical computing environments (R, Python, Julia)
4560

4661
---
4762

4863
## ✨ Why `pydhis2`?
4964

5065
* 🚀 **Modern & Asynchronous:** Built with `asyncio` for high-performance, non-blocking I/O, making it ideal for large-scale data operations. A synchronous client is also provided for simplicity in smaller scripts.
51-
* reproducible **Reproducible by Design:** From project templates to a powerful CLI, `pydhis2` is built to support standardized, shareable, and verifiable data analysis pipelines.
66+
* 🔬 **Reproducible by Design:** From project templates to a powerful CLI, `pydhis2` is built to support standardized, shareable, and verifiable data analysis pipelines—essential for scientific research.
5267
* 🐼 **Seamless DataFrame Integration:** Natively convert DHIS2 analytics data into Pandas DataFrames with a single method call (`.to_pandas()`), connecting you instantly to the PyData ecosystem.
5368
* 🔧 **Powerful Command Line Interface:** Automate common tasks like data pulling and configuration directly from your terminal.
5469

@@ -57,12 +72,26 @@
5772

5873
### 1. Installation
5974

75+
**Stable Release (Recommended)**
76+
6077
Install `pydhis2` directly from PyPI:
6178

6279
```bash
6380
pip install pydhis2
6481
```
6582

83+
**Development Installation**
84+
85+
For contributing or accessing the latest features:
86+
87+
```bash
88+
git clone https://github.com/HzaCode/pyDHIS2.git
89+
cd pyDHIS2
90+
pip install -e ".[dev]"
91+
```
92+
93+
See our [Contributing Guide](CONTRIBUTING.md) for more details on development setup.
94+
6695
### 2. Verify Your Installation
6796

6897
Use the built-in CLI to run a quick demo. This will connect to a live DHIS2 server, fetch data, and confirm that your installation is working correctly.
@@ -250,7 +279,7 @@ For a full list of commands, run `pydhis2 --help`.
250279
251280
## 🤝 Contributing
252281
253-
Contributions are welcome and highly encouraged! `pydhis2` is a community-driven project, and we believe that collaboration is key to building robust and useful tools for the open-science community.
282+
Contributions are welcome and highly encouraged! `pydhis2` is a community-driven project.
254283
255284
Please see our [**Contributing Guide**](CONTRIBUTING.md) for details on how to get started. Also, be sure to review our [**Code of Conduct**](CODE_OF_CONDUCT.md).
256285

0 commit comments

Comments
 (0)