A script for repeatedly polling files on a remote host using SSH and then downloading them using rsync.
Project description
Boba
A tool for polling a remote source over SSH and syncing new files from said source using rsync
.
Setup & Usage
Installation
TODO
Configuration
TODO
Usage
The key reference for using boba
is:
boba --help
Development
Standards
- Be excellent to each other
- Code coverage must be at 100% for all new code, or a good reason must be provided for why a given bit of code is not covered.
- Example of an acceptable reason: "There is a bug in the code coverage tool and it says its missing this, but its not".
- Example of unacceptable reason: "This is just exception handling, its too annoying to cover it".
- The code must pass the following analytics tools. Similar exceptions are allowable as in rule 2.
pylint --disable=C0103,C0111,W1203,R0903,R0913 --max-line-length=120 testudo
flake8 --max-line-length=120 ...
mypy --ignore-missing-imports --follow-imports=skip --strict-optional ...
- All incoming information from users, clients, and configurations should be validated.
- All internal arguments passing should be typechecked whenever possible with
typeguard.typechecked
Development Setup
Using pdm install from inside the repo directory:
pdm install
This will set up a virtualenv which you can always run specific commands with pdm run ...
.
IDE Setup
Sublime Text 3
curl -sSL https://gitlab.com/-/snippets/2066312/raw/master/poetry.sublime-project.py | pdm run python
Development
Testing
All testing should be done with pytest
which is installed with the --dev
requirements (pdm --dev install ...
).
To run all the unit tests, execute the following from the repo directory:
pdm run pytest
This should produce a coverage report in /path/to/dewey-api/htmlcov/
While developing, you can use watchexec
to monitor the file system for changes and re-run the tests:
watchexec -r -e py,yaml pdm run pytest
To run a specific test file:
pdm run pytest tests/unit/test_cli.py
To run a specific test:
pdm run pytest tests/unit/test_cli.py::test_cli_basics
For more information on testing, see the pytest.ini
file as well as the documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for boba_fetch-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 560bafac5a55100dd958c7bee07d3a28bf08d374c5143dac01ca132c67d5b11c |
|
MD5 | e51de4376e8e1fd248d9516d2e2a081d |
|
BLAKE2b-256 | 116da57bfb78ef367febed1b489d34b1ab058c41d978405315c4c6ee5365a0e5 |