|
41 | 41 | </p> |
42 | 42 | </div> |
43 | 43 |
|
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) |
45 | 60 |
|
46 | 61 | --- |
47 | 62 |
|
48 | 63 | ## ✨ Why `pydhis2`? |
49 | 64 |
|
50 | 65 | * 🚀 **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. |
52 | 67 | * 🐼 **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. |
53 | 68 | * 🔧 **Powerful Command Line Interface:** Automate common tasks like data pulling and configuration directly from your terminal. |
54 | 69 |
|
|
57 | 72 |
|
58 | 73 | ### 1. Installation |
59 | 74 |
|
| 75 | +**Stable Release (Recommended)** |
| 76 | + |
60 | 77 | Install `pydhis2` directly from PyPI: |
61 | 78 |
|
62 | 79 | ```bash |
63 | 80 | pip install pydhis2 |
64 | 81 | ``` |
65 | 82 |
|
| 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 | + |
66 | 95 | ### 2. Verify Your Installation |
67 | 96 |
|
68 | 97 | 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`. |
250 | 279 |
|
251 | 280 | ## 🤝 Contributing |
252 | 281 |
|
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. |
254 | 283 |
|
255 | 284 | 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). |
256 | 285 |
|
|
0 commit comments