| Tests | Skipped | Failures | Errors | Time |
|---|---|---|---|---|
| 5 | 0 💤 | 0 ❌ | 0 🔥 | 0.399s ⏱️ |
Official Supported OS: Windows. All below-mentioned instructions are given from Windows point of view.
May also work on Mac and Linux.
- To get started make sure you have Python version 3.10 or above installed into your system. If not, checkout this link. Once installed, verify using
python --version. - Have git installed into your system. If not, checkout this link. Once installed, verify using
git --version. - Go to your preferred directory and open the terminal/powershell.
- Execute:
git clone https://github.com/shubham-roy/donna.git. - Execute:
cd donna. - Execute:
pip install ..
With screenshot service users can set up to take screenshots for a specified duration with a control on the interval between two successive screenshots. The following options are available for fine-grained control:
| Option | Alias | Type | Required | Default | Description |
|---|---|---|---|---|---|
| --interval | -i | Integer | Yes | - | The gap between two consecutive screenshots in seconds. |
| --duration | -d | Integer | Yes | - | The total duration for which to take screenshots in minutes. |
| --path | -p | String | No | A folder named Donna in current directory of user. |
Full path of the folder to store the screenshots. If folder is absent, it will be created. |
An important usage note is not to keep interval more than duration.
Example: donna take-ss --interval 10 --duration 1 --path <your-desired-path>
- After executing steps 1-6 from Setup, execute:
pip install -r requirements_dev.txt. - Before pushing a change always execute:
black ./from the project root directory. - Give proper code-coverage for all your contributions and make sure that all unit-tests pass by executing
pytestfrom the project root directory. - Always use PRs to submit new changes. Add shubham-roy as a reviewer. Wait for shubham-roy approval before merging.
- Add proper documentation for your changes in the PR description and also update this README wherever necessary.
- Do not modify anything in the Code Coverage section of this README. It will be auto-updated by the CI workflow as and when needed.